blob: a23b823f38a3bd27c7ec80cbc405bcb2274f4d59 [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
Georg Brandl988049a2012-06-24 18:12:24 +020051.. note:: Beta users should be aware that this document is currently in
Nick Coghlanb47b5392012-05-26 01:31:25 +100052 draft form. It will be updated substantially as Python 3.3 moves towards
53 release, so it's worth checking back even after reading earlier versions.
54
55
Éric Araujo859aad62012-06-24 00:07:41 -040056PEP 405: Virtual Environments
57=============================
Nick Coghlanb47b5392012-05-26 01:31:25 +100058
Éric Araujo859aad62012-06-24 00:07:41 -040059- inspired by ``virtualenv``, a tool widely used by the community
60- change to the interpreter to avoid hacks
Nick Coghlanb47b5392012-05-26 01:31:25 +100061
Éric Araujo859aad62012-06-24 00:07:41 -040062The :mod:`venv` module and ``pyvenv`` script (inspired by ``virtualenv``, a
63tool widely used by the community).
64
65.. also mention the interpreter changes that avoid the hacks used in virtualenv
Nick Coghlanb47b5392012-05-26 01:31:25 +100066
Giampaolo Rodolà3108f982011-02-24 20:59:48 +000067
Éric Araujo859aad62012-06-24 00:07:41 -040068PEP 420: Namespace Packages
69===========================
70
71Native support for package directories that don't require ``__init__.py``
72marker files and can automatically span multiple path segments (inspired by
73various third party approaches to namespace packages, as described in
74:pep:`420`)
75
76
77.. _pep-3118-update:
Nick Coghlan98e20702012-03-06 21:50:13 +100078
Stefan Krah9a2d99e2012-02-25 12:24:21 +010079PEP 3118: New memoryview implementation and buffer protocol documentation
80=========================================================================
81
82:issue:`10181` - memoryview bug fixes and features.
83 Written by Stefan Krah.
84
85The new memoryview implementation comprehensively fixes all ownership and
86lifetime issues of dynamically allocated fields in the Py_buffer struct
87that led to multiple crash reports. Additionally, several functions that
88crashed or returned incorrect results for non-contiguous or multi-dimensional
89input have been fixed.
90
91The memoryview object now has a PEP-3118 compliant getbufferproc()
92that checks the consumer's request type. Many new features have been
93added, most of them work in full generality for non-contiguous arrays
94and arrays with suboffsets.
95
96The documentation has been updated, clearly spelling out responsibilities
97for both exporters and consumers. Buffer request flags are grouped into
98basic and compound flags. The memory layout of non-contiguous and
99multi-dimensional NumPy-style arrays is explained.
100
101Features
102--------
103
104* All native single character format specifiers in struct module syntax
105 (optionally prefixed with '@') are now supported.
106
107* With some restrictions, the cast() method allows changing of format and
108 shape of C-contiguous arrays.
109
110* Multi-dimensional list representations are supported for any array type.
111
112* Multi-dimensional comparisons are supported for any array type.
113
114* All array types are hashable if the exporting object is hashable
Nick Coghlan98e20702012-03-06 21:50:13 +1000115 and the view is read-only. (Contributed by Antoine Pitrou in
116 :issue:`13411`)
117
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100118
119* Arbitrary slicing of any 1-D arrays type is supported. For example, it
120 is now possible to reverse a memoryview in O(1) by using a negative step.
121
122API changes
123-----------
124
125* The maximum number of dimensions is officially limited to 64.
126
127* The representation of empty shape, strides and suboffsets is now
128 an empty tuple instead of None.
129
130* Accessing a memoryview element with format 'B' (unsigned bytes)
131 now returns an integer (in accordance with the struct module syntax).
132 For returning a bytes object the view must be cast to 'c' first.
133
Stefan Krah54c32032012-02-29 17:47:21 +0100134* For further changes see `Build and C API Changes`_ and `Porting C code`_ .
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100135
Antoine Pitrou037ffbf2011-10-24 00:25:41 +0200136.. _pep-393:
137
Ezio Melotti48a2f8f2011-09-29 00:18:19 +0300138PEP 393: Flexible String Representation
139=======================================
140
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200141The Unicode string type is changed to support multiple internal
142representations, depending on the character with the largest Unicode ordinal
143(1, 2, or 4 bytes) in the represented string. This allows a space-efficient
144representation in common cases, but gives access to full UCS-4 on all
145systems. For compatibility with existing APIs, several representations may
146exist in parallel; over time, this compatibility should be phased out.
Ezio Melotti397546a2011-09-29 08:34:36 +0300147
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200148On the Python side, there should be no downside to this change.
Ezio Melotti397546a2011-09-29 08:34:36 +0300149
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200150On the C API side, PEP 393 is fully backward compatible. The legacy API
151should remain available at least five years. Applications using the legacy
152API will not fully benefit of the memory reduction, or - worse - may use
153a bit more memory, because Python may have to maintain two versions of each
154string (in the legacy format and in the new efficient storage).
155
Antoine Pitrou0599b5b2011-11-29 22:45:07 +0100156Functionality
157-------------
158
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200159Changes introduced by :pep:`393` are the following:
Ezio Melotti48a2f8f2011-09-29 00:18:19 +0300160
Ezio Melotti397546a2011-09-29 08:34:36 +0300161* Python now always supports the full range of Unicode codepoints, including
162 non-BMP ones (i.e. from ``U+0000`` to ``U+10FFFF``). The distinction between
163 narrow and wide builds no longer exists and Python now behaves like a wide
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200164 build, even under Windows.
Ezio Melotti397546a2011-09-29 08:34:36 +0300165
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200166* With the death of narrow builds, the problems specific to narrow builds have
167 also been fixed, for example:
Ezio Melotti397546a2011-09-29 08:34:36 +0300168
169 * :func:`len` now always returns 1 for non-BMP characters,
170 so ``len('\U0010FFFF') == 1``;
171
172 * surrogate pairs are not recombined in string literals,
173 so ``'\uDBFF\uDFFF' != '\U0010FFFF'``;
174
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200175 * indexing or slicing non-BMP characters returns the expected value,
Ezio Melotti397546a2011-09-29 08:34:36 +0300176 so ``'\U0010FFFF'[0]`` now returns ``'\U0010FFFF'`` and not ``'\uDBFF'``;
177
Antoine Pitroud136aec2011-11-17 01:48:06 +0100178 * all other functions in the standard library now correctly handle
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200179 non-BMP codepoints.
Ezio Melotti397546a2011-09-29 08:34:36 +0300180
Ezio Melotti48a2f8f2011-09-29 00:18:19 +0300181* The value of :data:`sys.maxunicode` is now always ``1114111`` (``0x10FFFF``
182 in hexadecimal). The :c:func:`PyUnicode_GetMax` function still returns
183 either ``0xFFFF`` or ``0x10FFFF`` for backward compatibility, and it should
184 not be used with the new Unicode API (see :issue:`13054`).
185
Ezio Melotti397546a2011-09-29 08:34:36 +0300186* The :file:`./configure` flag ``--with-wide-unicode`` has been removed.
Victor Stinner7d637ab2011-09-29 02:56:16 +0200187
Antoine Pitrou0599b5b2011-11-29 22:45:07 +0100188Performance and resource usage
189------------------------------
190
191The storage of Unicode strings now depends on the highest codepoint in the string:
192
193* pure ASCII and Latin1 strings (``U+0000-U+00FF``) use 1 byte per codepoint;
194
195* BMP strings (``U+0000-U+FFFF``) use 2 bytes per codepoint;
196
197* non-BMP strings (``U+10000-U+10FFFF``) use 4 bytes per codepoint.
198
Martin v. Löwisde157cc2012-03-06 08:42:17 +0100199The net effect is that for most applications, memory usage of string
200storage should decrease significantly - especially compared to former
201wide unicode builds - as, in many cases, strings will be pure ASCII
202even in international contexts (because many strings store non-human
203language data, such as XML fragments, HTTP headers, JSON-encoded data,
204etc.). We also hope that it will, for the same reasons, increase CPU
205cache efficiency on non-trivial applications. The memory usage of
206Python 3.3 is two to three times smaller than Python 3.2, and a little
207bit better than Python 2.7, on a Django benchmark (see the PEP for
208details).
Antoine Pitrou0599b5b2011-11-29 22:45:07 +0100209
Éric Araujob07b97f2011-10-05 01:03:34 +0200210
Victor Stinnera1bf2982011-10-12 20:35:02 +0200211PEP 3151: Reworking the OS and IO exception hierarchy
212=====================================================
213
214:pep:`3151` - Reworking the OS and IO exception hierarchy
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200215 PEP written and implemented by Antoine Pitrou.
Victor Stinnera1bf2982011-10-12 20:35:02 +0200216
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200217The hierarchy of exceptions raised by operating system errors is now both
218simplified and finer-grained.
Victor Stinnera1bf2982011-10-12 20:35:02 +0200219
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200220You don't have to worry anymore about choosing the appropriate exception
221type between :exc:`OSError`, :exc:`IOError`, :exc:`EnvironmentError`,
222:exc:`WindowsError`, :exc:`mmap.error`, :exc:`socket.error` or
223:exc:`select.error`. All these exception types are now only one:
224:exc:`OSError`. The other names are kept as aliases for compatibility
225reasons.
Victor Stinnera1bf2982011-10-12 20:35:02 +0200226
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200227Also, it is now easier to catch a specific error condition. Instead of
228inspecting the ``errno`` attribute (or ``args[0]``) for a particular
229constant from the :mod:`errno` module, you can catch the adequate
230:exc:`OSError` subclass. The available subclasses are the following:
Victor Stinnera1bf2982011-10-12 20:35:02 +0200231
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200232* :exc:`BlockingIOError`
233* :exc:`ChildProcessError`
234* :exc:`ConnectionError`
235* :exc:`FileExistsError`
236* :exc:`FileNotFoundError`
237* :exc:`InterruptedError`
238* :exc:`IsADirectoryError`
239* :exc:`NotADirectoryError`
240* :exc:`PermissionError`
241* :exc:`ProcessLookupError`
242* :exc:`TimeoutError`
Victor Stinnera1bf2982011-10-12 20:35:02 +0200243
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200244And the :exc:`ConnectionError` itself has finer-grained subclasses:
Victor Stinnera1bf2982011-10-12 20:35:02 +0200245
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200246* :exc:`BrokenPipeError`
247* :exc:`ConnectionAbortedError`
248* :exc:`ConnectionRefusedError`
249* :exc:`ConnectionResetError`
Victor Stinnera1bf2982011-10-12 20:35:02 +0200250
251Thanks to the new exceptions, common usages of the :mod:`errno` can now be
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200252avoided. For example, the following code written for Python 3.2::
Victor Stinnera1bf2982011-10-12 20:35:02 +0200253
254 from errno import ENOENT, EACCES, EPERM
255
256 try:
257 with open("document.txt") as f:
258 content = f.read()
259 except IOError as err:
260 if err.errno == ENOENT:
261 print("document.txt file is missing")
262 elif err.errno in (EACCES, EPERM):
263 print("You are not allowed to read document.txt")
264 else:
265 raise
266
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200267can now be written without the :mod:`errno` import and without manual
268inspection of exception attributes::
Victor Stinnera1bf2982011-10-12 20:35:02 +0200269
270 try:
271 with open("document.txt") as f:
272 content = f.read()
273 except FileNotFoundError:
274 print("document.txt file is missing")
275 except PermissionError:
276 print("You are not allowed to read document.txt")
277
278
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000279PEP 380: Syntax for Delegating to a Subgenerator
280================================================
281
Nick Coghlanab7bf212012-02-26 17:49:52 +1000282:pep:`380` - Syntax for Delegating to a Subgenerator
283 PEP written by Greg Ewing.
284
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000285PEP 380 adds the ``yield from`` expression, allowing a generator to delegate
286part of its operations to another generator. This allows a section of code
287containing 'yield' to be factored out and placed in another generator.
288Additionally, the subgenerator is allowed to return with a value, and the
289value is made available to the delegating generator.
Nick Coghlanb9b281b2012-03-06 22:31:12 +1000290
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000291While designed primarily for use in delegating to a subgenerator, the ``yield
292from`` expression actually allows delegation to arbitrary subiterators.
293
Nick Coghlanb9b281b2012-03-06 22:31:12 +1000294For simple iterators, ``yield from iterable`` is essentially just a shortened
295form of ``for item in iterable: yield item``::
296
297 >>> def g(x):
298 ... yield from range(x, 0, -1)
299 ... yield from range(x)
300 ...
301 >>> list(g(5))
302 [5, 4, 3, 2, 1, 0, 1, 2, 3, 4]
303
304However, unlike an ordinary loop, ``yield from`` allows subgenerators to
305receive sent and thrown values directly from the calling scope, and
306return a final value to the outer generator::
307
308 >>> def accumulate(start=0):
309 ... tally = start
310 ... while 1:
311 ... next = yield
312 ... if next is None:
313 ... return tally
314 ... tally += next
315 ...
316 >>> def gather_tallies(tallies, start=0):
317 ... while 1:
318 ... tally = yield from accumulate()
319 ... tallies.append(tally)
320 ...
321 >>> tallies = []
322 >>> acc = gather_tallies(tallies)
323 >>> next(acc) # Ensure the accumulator is ready to accept values
324 >>> for i in range(10):
325 ... acc.send(i)
326 ...
327 >>> acc.send(None) # Finish the first tally
328 >>> for i in range(5):
329 ... acc.send(i)
330 ...
331 >>> acc.send(None) # Finish the second tally
332 >>> tallies
333 [45, 10]
334
335The main principle driving this change is to allow even generators that are
336designed to be used with the ``send`` and ``throw`` methods to be split into
337multiple subgenerators as easily as a single large function can be split into
338multiple subfunctions.
339
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000340(Implementation by Greg Ewing, integrated into 3.3 by Renaud Blanch, Ryan
341Kelly and Nick Coghlan, documentation by Zbigniew Jędrzejewski-Szmek and
342Nick Coghlan)
343
344
Nick Coghlanab7bf212012-02-26 17:49:52 +1000345PEP 409: Suppressing exception context
346======================================
347
348:pep:`409` - Suppressing exception context
349 PEP written by Ethan Furman, implemented by Ethan Furman and Nick Coghlan.
350
351PEP 409 introduces new syntax that allows the display of the chained
352exception context to be disabled. This allows cleaner error messages in
353applications that convert between exception types::
354
355 >>> class D:
356 ... def __init__(self, extra):
357 ... self._extra_attributes = extra
358 ... def __getattr__(self, attr):
359 ... try:
360 ... return self._extra_attributes[attr]
361 ... except KeyError:
362 ... raise AttributeError(attr) from None
363 ...
364 >>> D({}).x
365 Traceback (most recent call last):
366 File "<stdin>", line 1, in <module>
367 File "<stdin>", line 8, in __getattr__
368 AttributeError: x
369
370Without the ``from None`` suffix to suppress the cause, the original
371exception would be displayed by default::
372
373 >>> class C:
374 ... def __init__(self, extra):
375 ... self._extra_attributes = extra
376 ... def __getattr__(self, attr):
377 ... try:
378 ... return self._extra_attributes[attr]
379 ... except KeyError:
380 ... raise AttributeError(attr)
381 ...
382 >>> C({}).x
383 Traceback (most recent call last):
384 File "<stdin>", line 6, in __getattr__
385 KeyError: 'x'
386
387 During handling of the above exception, another exception occurred:
388
389 Traceback (most recent call last):
390 File "<stdin>", line 1, in <module>
391 File "<stdin>", line 8, in __getattr__
392 AttributeError: x
393
394No debugging capability is lost, as the original exception context remains
395available if needed (for example, if an intervening library has incorrectly
396suppressed valuable underlying details)::
397
398 >>> try:
399 ... D({}).x
400 ... except AttributeError as exc:
401 ... print(repr(exc.__context__))
402 ...
403 KeyError('x',)
404
405
Nick Coghlan98e20702012-03-06 21:50:13 +1000406PEP 414: Explicit Unicode literals
407======================================
408
409:pep:`414` - Explicit Unicode literals
410 PEP written by Armin Ronacher.
411
412To ease the transition from Python 2 for Unicode aware Python applications
413that make heavy use of Unicode literals, Python 3.3 once again supports the
414"``u``" prefix for string literals. This prefix has no semantic significance
415in Python 3, it is provided solely to reduce the number of purely mechanical
416changes in migrating to Python 3, making it easier for developers to focus on
417the more significant semantic changes (such as the stricter default
418separation of binary and text data).
419
420
Antoine Pitrou6bbd76b2011-11-25 19:10:05 +0100421PEP 3155: Qualified name for classes and functions
422==================================================
423
424:pep:`3155` - Qualified name for classes and functions
425 PEP written and implemented by Antoine Pitrou.
426
427Functions and class objects have a new ``__qualname__`` attribute representing
428the "path" from the module top-level to their definition. For global functions
429and classes, this is the same as ``__name__``. For other functions and classes,
430it provides better information about where they were actually defined, and
431how they might be accessible from the global scope.
432
433Example with (non-bound) methods::
Nick Coghlan2dfe6b02012-01-14 14:19:49 +1000434
Antoine Pitrou6bbd76b2011-11-25 19:10:05 +0100435 >>> class C:
436 ... def meth(self):
437 ... pass
438 >>> C.meth.__name__
439 'meth'
440 >>> C.meth.__qualname__
441 'C.meth'
442
443Example with nested classes::
444
445 >>> class C:
446 ... class D:
447 ... def meth(self):
448 ... pass
449 ...
450 >>> C.D.__name__
451 'D'
452 >>> C.D.__qualname__
453 'C.D'
454 >>> C.D.meth.__name__
455 'meth'
456 >>> C.D.meth.__qualname__
457 'C.D.meth'
458
459Example with nested functions::
460
461 >>> def outer():
462 ... def inner():
463 ... pass
464 ... return inner
465 ...
466 >>> outer().__name__
467 'inner'
468 >>> outer().__qualname__
469 'outer.<locals>.inner'
470
Antoine Pitroue7ede062011-11-25 19:11:26 +0100471The string representation of those objects is also changed to include the
Antoine Pitrou6bbd76b2011-11-25 19:10:05 +0100472new, more precise information::
473
474 >>> str(C.D)
475 "<class '__main__.C.D'>"
476 >>> str(C.D.meth)
477 '<function C.D.meth at 0x7f46b9fe31e0>'
478
479
Brett Cannonc2043482012-04-29 20:59:41 -0400480Using importlib as the Implementation of Import
481===============================================
482:issue:`2377` - Replace __import__ w/ importlib.__import__
483:issue:`13959` - Re-implement parts of :mod:`imp` in pure Python
484:issue:`14605` - Make import machinery explicit
485:issue:`14646` - Require loaders set __loader__ and __package__
486
487(Written by Brett Cannon)
488
489The :func:`__import__` function is now powered by :func:`importlib.__import__`.
490This work leads to the completion of "phase 2" of :pep:`302`. There are
491multiple benefits to this change. First, it has allowed for more of the
492machinery powering import to be exposed instead of being implicit and hidden
493within the C code. It also provides a single implementation for all Python VMs
494supporting Python 3.3 to use, helping to end any VM-specific deviations in
495import semantics. And finally it eases the maintenance of import, allowing for
496future growth to occur.
497
498For the common user, this change should result in no visible change in
499semantics. Any possible changes required in one's code to handle this change
500should read the `Porting Python code`_ section of this document to see what
501needs to be changed, but it will only affect those that currently manipulate
502import or try calling it programmatically.
503
504New APIs
505--------
506One of the large benefits of this work is the exposure of what goes into
507making the import statement work. That means the various importers that were
508once implicit are now fully exposed as part of the :mod:`importlib` package.
509
510In terms of finders, * :class:`importlib.machinery.FileFinder` exposes the
511mechanism used to search for source and bytecode files of a module. Previously
512this class was an implicit member of :attr:`sys.path_hooks`.
513
514For loaders, the new abstract base class :class:`importlib.abc.FileLoader` helps
515write a loader that uses the file system as the storage mechanism for a module's
516code. The loader for source files
517(:class:`importlib.machinery.SourceFileLoader`), sourceless bytecode files
518(:class:`importlib.machinery.SourcelessFileLoader`), and extension modules
519(:class:`importlib.machinery.ExtensionFileLoader`) are now available for
520direct use.
521
522:exc:`ImportError` now has ``name`` and ``path`` attributes which are set when
523there is relevant data to provide. The message for failed imports will also
524provide the full name of the module now instead of just the tail end of the
525module's name.
526
527The :func:`importlib.invalidate_caches` function will now call the method with
528the same name on all finders cached in :attr:`sys.path_importer_cache` to help
529clean up any stored state as necessary.
530
531Visible Changes
532---------------
533[For potential required changes to code, see the `Porting Python code`_
534section]
535
536Beyond the expanse of what :mod:`importlib` now exposes, there are other
537visible changes to import. The biggest is that :attr:`sys.meta_path` and
538:attr:`sys.path_hooks` now store all of the finders used by import explicitly.
539Previously the finders were implicit and hidden within the C code of import
540instead of being directly exposed. This means that one can now easily remove or
541change the order of the various finders to fit one's needs.
542
543Another change is that all modules have a ``__loader__`` attribute, storing the
544loader used to create the module. :pep:`302` has been updated to make this
545attribute mandatory for loaders to implement, so in the future once 3rd-party
546loaders have been updated people will be able to rely on the existence of the
547attribute. Until such time, though, import is setting the module post-load.
548
549Loaders are also now expected to set the ``__package__`` attribute from
550:pep:`366`. Once again, import itself is already setting this on all loaders
551from :mod:`importlib` and import itself is setting the attribute post-load.
552
553``None`` is now inserted into :attr:`sys.path_importer_cache` when no finder
554can be found on :attr:`sys.path_hooks`. Since :class:`imp.NullImporter` is not
555directly exposed on :attr:`sys.path_hooks` it could no longer be relied upon to
556always be available to use as a value representing no finder found.
557
558All other changes relate to semantic changes which should be taken into
559consideration when updating code for Python 3.3, and thus should be read about
560in the `Porting Python code`_ section of this document.
561
562
R David Murray0fa2edd2012-05-25 17:59:56 -0400563New Email Package Features
564==========================
565
R David Murraycb448cf2012-05-25 22:25:56 -0400566Policy Framework
567----------------
568
R David Murray0fa2edd2012-05-25 17:59:56 -0400569The email package now has a :mod:`~email.policy` framework. A
570:class:`~email.policy.Policy` is an object with several methods and properties
571that control how the email package behaves. The primary policy for Python 3.3
572is the :class:`~email.policy.Compat32` policy, which provides backward
573compatibility with the email package in Python 3.2. A ``policy`` can be
574specified when an email message is parsed by a :mod:`~email.parser`, or when a
575:class:`~email.message.Message` object is created, or when an email is
576serialized using a :mod:`~email.generator`. Unless overridden, a policy passed
577to a ``parser`` is inherited by all the ``Message`` object and sub-objects
578created by the ``parser``. By default a ``generator`` will use the policy of
579the ``Message`` object it is serializing. The default policy is
580:data:`~email.policy.compat32`.
581
582The minimum set of controls implemented by all ``policy`` objects are:
583
584 =============== =======================================================
585 max_line_length The maximum length, excluding the linesep character(s),
586 individual lines may have when a ``Message`` is
587 serialized. Defaults to 78.
588
589 linesep The character used to separate individual lines when a
590 ``Message`` is serialized. Defaults to ``\n``.
591
592 cte_type ``7bit`` or ``8bit``. ``8bit`` applies only to a
593 ``Bytes`` ``generator``, and means that non-ASCII may
594 be used where allowed by the protocol (or where it
595 exists in the original input).
596
597 raise_on_defect Causes a ``parser`` to raise error when defects are
598 encountered instead of adding them to the ``Message``
599 object's ``defects`` list.
600 =============== =======================================================
601
602A new policy instance, with new settings, is created using the
603:meth:`~email.policy.Policy.clone` method of policy objects. ``clone`` takes
604any of the above controls as keyword arguments. Any control not specified in
605the call retains its default value. Thus you can create a policy that uses
606``\r\n`` linesep characters like this::
607
Georg Brandl3539afd2012-05-30 22:03:20 +0200608 mypolicy = compat32.clone(linesep='\r\n')
R David Murray0fa2edd2012-05-25 17:59:56 -0400609
610Policies can be used to make the generation of messages in the format needed by
611your application simpler. Instead of having to remember to specify
612``linesep='\r\n'`` in all the places you call a ``generator``, you can specify
613it once, when you set the policy used by the ``parser`` or the ``Message``,
614whichever your program uses to create ``Message`` objects. On the other hand,
615if you need to generate messages in multiple forms, you can still specify the
616parameters in the appropriate ``generator`` call. Or you can have custom
617policy instances for your different cases, and pass those in when you create
618the ``generator``.
619
620
R David Murraycb448cf2012-05-25 22:25:56 -0400621Provisional Policy with New Header API
622--------------------------------------
623
624While the policy framework is worthwhile all by itself, the main motivation for
625introducing it is to allow the creation of new policies that implement new
626features for the email package in a way that maintains backward compatibility
627for those who do not use the new policies. Because the new policies introduce a
628new API, we are releasing them in Python 3.3 as a :term:`provisional policy
629<provisional package>`. Backwards incompatible changes (up to and including
630removal of the code) may occur if deemed necessary by the core developers.
631
632The new policies are instances of :class:`~email.policy.EmailPolicy`,
633and add the following additional controls:
634
635 =============== =======================================================
636 refold_source Controls whether or not headers parsed by a
637 :mod:`~email.parser` are refolded by the
638 :mod:`~email.generator`. It can be ``none``, ``long``,
639 or ``all``. The default is ``long``, which means that
640 source headers with a line longer than
641 ``max_line_length`` get refolded. ``none`` means no
642 line get refolded, and ``all`` means that all lines
643 get refolded.
644
645 header_factory A callable that take a ``name`` and ``value`` and
646 produces a custom header object.
647 =============== =======================================================
648
649The ``header_factory`` is the key to the new features provided by the new
650policies. When one of the new policies is used, any header retrieved from
651a ``Message`` object is an object produced by the ``header_factory``, and any
652time you set a header on a ``Message`` it becomes an object produced by
653``header_factory``. All such header objects have a ``name`` attribute equal
654to the header name. Address and Date headers have additional attributes
655that give you access to the parsed data of the header. This means you can now
656do things like this::
657
658 >>> m = Message(policy=SMTP)
659 >>> m['To'] = 'Éric <foo@example.com>'
660 >>> m['to']
661 'Éric <foo@example.com>'
662 >>> m['to'].addresses
663 (Address(display_name='Éric', username='foo', domain='example.com'),)
664 >>> m['to'].addresses[0].username
665 'foo'
666 >>> m['to'].addresses[0].display_name
667 'Éric'
668 >>> m['Date'] = email.utils.localtime()
669 >>> m['Date'].datetime
670 datetime.datetime(2012, 5, 25, 21, 39, 24, 465484, tzinfo=datetime.timezone(datetime.timedelta(-1, 72000), 'EDT'))
671 >>> m['Date']
672 'Fri, 25 May 2012 21:44:27 -0400'
673 >>> print(m)
674 To: =?utf-8?q?=C3=89ric?= <foo@example.com>
675 Date: Fri, 25 May 2012 21:44:27 -0400
676
677You will note that the unicode display name is automatically encoded as
678``utf-8`` when the message is serialized, but that when the header is accessed
679directly, you get the unicode version. This eliminates any need to deal with
680the :mod:`email.header` :meth:`~email.header.decode_header` or
681:meth:`~email.header.make_header` functions.
682
683You can also create addresses from parts::
684
685 >>> m['cc'] = [Group('pals', [Address('Bob', 'bob', 'example.com'),
686 ... Address('Sally', 'sally', 'example.com')]),
687 ... Address('Bonzo', addr_spec='bonz@laugh.com')]
688 >>> print(m)
689 To: =?utf-8?q?=C3=89ric?= <foo@example.com>
690 Date: Fri, 25 May 2012 21:44:27 -0400
691 cc: pals: Bob <bob@example.com>, Sally <sally@example.com>;, Bonzo <bonz@laugh.com>
692
693Decoding to unicode is done automatically::
694
695 >>> m2 = message_from_string(str(m))
696 >>> m2['to']
697 'Éric <foo@example.com>'
698
699When you parse a message, you can use the ``addresses`` and ``groups``
700attributes of the header objects to access the groups and individual
701addresses::
702
703 >>> m2['cc'].addresses
704 (Address(display_name='Bob', username='bob', domain='example.com'), Address(display_name='Sally', username='sally', domain='example.com'), Address(display_name='Bonzo', username='bonz', domain='laugh.com'))
705 >>> m2['cc'].groups
706 (Group(display_name='pals', addresses=(Address(display_name='Bob', username='bob', domain='example.com'), Address(display_name='Sally', username='sally', domain='example.com')), Group(display_name=None, addresses=(Address(display_name='Bonzo', username='bonz', domain='laugh.com'),))
707
708In summary, if you use one of the new policies, header manipulation works the
709way it ought to: your application works with unicode strings, and the email
710package transparently encodes and decodes the unicode to and from the RFC
711standard Content Transfer Encodings.
712
713
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000714Other Language Changes
715======================
716
717Some smaller changes made to the core Python language are:
718
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100719* Added support for Unicode name aliases and named sequences.
720 Both :func:`unicodedata.lookup()` and ``'\N{...}'`` now resolve name aliases,
721 and :func:`unicodedata.lookup()` resolves named sequences too.
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000722
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100723 (Contributed by Ezio Melotti in :issue:`12753`)
Ezio Melotti931b8aa2011-10-21 21:57:36 +0300724
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100725* Equality comparisons on :func:`range` objects now return a result reflecting
726 the equality of the underlying sequences generated by those range objects.
Ezio Melotti931b8aa2011-10-21 21:57:36 +0300727
Sandro Tosicd899122012-01-22 12:16:04 +0100728 (:issue:`13201`)
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000729
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100730* The ``count()``, ``find()``, ``rfind()``, ``index()`` and ``rindex()``
731 methods of :class:`bytes` and :class:`bytearray` objects now accept an
732 integer between 0 and 255 as their first argument.
Mark Dickinson36645682011-10-23 19:53:01 +0100733
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100734 (:issue:`12170`)
Mark Dickinson36645682011-10-23 19:53:01 +0100735
Eli Bendersky7add4ea2012-03-17 15:14:35 +0200736* New methods have been added to :class:`list` and :class:`bytearray`:
737 ``copy()`` and ``clear()``.
738
739 (:issue:`10516`)
Petri Lehtinen61ea8a02011-11-24 22:00:46 +0200740
Antoine Pitrou9a864472012-05-04 23:15:47 +0200741* Raw bytes literals can now be written ``rb"..."`` as well as ``br"..."``.
742 (Contributed by Antoine Pitrou in :issue:`13748`.)
743
744* :meth:`dict.setdefault` now does only one lookup for the given key, making
745 it atomic when used with built-in types.
746 (Contributed by Filip Gruszczyński in :issue:`13521`.)
747
748
Benjamin Petersone50d6ab2012-04-03 00:52:18 -0400749.. XXX mention new error messages for passing wrong number of arguments to functions
750
Antoine Pitrou9a864472012-05-04 23:15:47 +0200751
Antoine Pitrou79341e72012-05-17 21:13:45 +0200752A Finer-Grained Import Lock
753===========================
754
755Previous versions of CPython have always relied on a global import lock.
756This led to unexpected annoyances, such as deadlocks when importing a module
757would trigger code execution in a different thread as a side-effect.
758Clumsy workarounds were sometimes employed, such as the
759:c:func:`PyImport_ImportModuleNoBlock` C API function.
760
761In Python 3.3, importing a module takes a per-module lock. This correctly
762serializes importation of a given module from multiple threads (preventing
763the exposure of incompletely initialized modules), while eliminating the
764aforementioned annoyances.
765
766(contributed by Antoine Pitrou in :issue:`9260`.)
767
768
Victor Stinner46606ce2011-11-20 18:27:55 +0100769New and Improved Modules
770========================
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000771
Victor Stinnerf4c54ff2012-02-08 01:48:34 +0100772abc
773---
774
775Improved support for abstract base classes containing descriptors composed with
776abstract methods. The recommended approach to declaring abstract descriptors is
777now to provide :attr:`__isabstractmethod__` as a dynamically updated
778property. The built-in descriptors have been updated accordingly.
779
780 * :class:`abc.abstractproperty` has been deprecated, use :class:`property`
781 with :func:`abc.abstractmethod` instead.
782 * :class:`abc.abstractclassmethod` has been deprecated, use
783 :class:`classmethod` with :func:`abc.abstractmethod` instead.
784 * :class:`abc.abstractstaticmethod` has been deprecated, use
785 :class:`staticmethod` with :func:`abc.abstractmethod` instead.
786
787(Contributed by Darren Dale in :issue:`11610`)
788
Meador Ingec5dbb3d2011-09-20 21:48:16 -0500789array
790-----
791
792The :mod:`array` module supports the :c:type:`long long` type using ``q`` and
793``Q`` type codes.
794
795(Contributed by Oren Tirosh and Hirokazu Yamamoto in :issue:`1172711`)
796
797
Nadeem Vawdad7e5c6e2012-02-12 01:34:18 +0200798bz2
799---
800
801The :mod:`bz2` module has been rewritten from scratch. In the process, several
802new features have been added:
803
804* :class:`bz2.BZ2File` can now read from and write to arbitrary file-like
805 objects, by means of its constructor's *fileobj* argument.
806
807 (Contributed by Nadeem Vawda in :issue:`5863`)
808
809* :class:`bz2.BZ2File` and :func:`bz2.decompress` can now decompress
810 multi-stream inputs (such as those produced by the :program:`pbzip2` tool).
811 :class:`bz2.BZ2File` can now also be used to create this type of file, using
812 the ``'a'`` (append) mode.
813
814 (Contributed by Nir Aides in :issue:`1625`)
815
816* :class:`bz2.BZ2File` now implements all of the :class:`io.BufferedIOBase` API,
817 except for the :meth:`detach` and :meth:`truncate` methods.
818
819
Victor Stinner2cded9c2011-07-08 01:45:13 +0200820codecs
821------
822
Antoine Pitrou4f863432012-02-12 02:12:47 +0100823The :mod:`~encodings.mbcs` codec has been rewritten to handle correctly
Georg Brandlff962c52012-02-04 08:55:56 +0100824``replace`` and ``ignore`` error handlers on all Windows versions. The
825:mod:`~encodings.mbcs` codec now supports all error handlers, instead of only
826``replace`` to encode and ``ignore`` to decode.
Victor Stinner3a50e702011-10-18 21:21:00 +0200827
Georg Brandlff962c52012-02-04 08:55:56 +0100828A new Windows-only codec has been added: ``cp65001`` (:issue:`13216`). It is the
829Windows code page 65001 (Windows UTF-8, ``CP_UTF8``). For example, it is used
830by ``sys.stdout`` if the console output code page is set to cp65001 (e.g., using
831``chcp 65001`` command).
Victor Stinner2f3ca9f2011-10-27 01:38:56 +0200832
Georg Brandlff962c52012-02-04 08:55:56 +0100833Multibyte CJK decoders now resynchronize faster. They only ignore the first
Georg Brandl6c0929b2011-07-09 11:43:33 +0200834byte of an invalid byte sequence. For example, ``b'\xff\n'.decode('gb2312',
835'replace')`` now returns a ``\n`` after the replacement character.
Victor Stinner2cded9c2011-07-08 01:45:13 +0200836
Georg Brandl6c0929b2011-07-09 11:43:33 +0200837(:issue:`12016`)
Victor Stinner2cded9c2011-07-08 01:45:13 +0200838
Georg Brandlff962c52012-02-04 08:55:56 +0100839Incremental CJK codec encoders are no longer reset at each call to their
840encode() methods. For example::
Victor Stinner2cded9c2011-07-08 01:45:13 +0200841
842 $ ./python -q
843 >>> import codecs
844 >>> encoder = codecs.getincrementalencoder('hz')('strict')
845 >>> b''.join(encoder.encode(x) for x in '\u52ff\u65bd\u65bc\u4eba\u3002 Bye.')
846 b'~{NpJ)l6HK!#~} Bye.'
847
Georg Brandl6c0929b2011-07-09 11:43:33 +0200848This example gives ``b'~{Np~}~{J)~}~{l6~}~{HK~}~{!#~} Bye.'`` with older Python
Victor Stinner2cded9c2011-07-08 01:45:13 +0200849versions.
850
Georg Brandl6c0929b2011-07-09 11:43:33 +0200851(:issue:`12100`)
Victor Stinner2cded9c2011-07-08 01:45:13 +0200852
Victor Stinner9f4b1e92011-11-10 20:56:30 +0100853The ``unicode_internal`` codec has been deprecated.
854
Éric Araujo4f61a2d2012-04-04 23:01:01 -0400855
856collections
857-----------
858
859Addition of a new :class:`~collections.ChainMap` class to allow treating a
860number of mappings as a single unit.
861
862(Written by Raymond Hettinger for :issue:`11089`, made public in
863:issue:`11297`)
864
865The abstract base classes have been moved in a new :mod:`collections.abc`
866module, to better differentiate between the abstract and the concrete
867collections classes. Aliases for ABCs are still present in the
868:mod:`collections` module to preserve existing imports.
869
870(:issue:`11085`)
871
872.. XXX addition of __slots__ to ABCs not recorded here: internal detail
873
874
Nick Coghlan3267a302012-05-21 22:54:43 +1000875contextlib
876----------
877
878:class:`~collections.ExitStack` now provides a solid foundation for
879programmatic manipulation of context managers and similar cleanup
880functionality. Unlike the previous ``contextlib.nested`` API (which was
881deprecated and removed), the new API is designed to work correctly
882regardless of whether context managers acquire their resources in
Nick Coghlan161ea6a2012-05-22 23:04:42 +1000883their ``__init__`` method (for example, file objects) or in their
Nick Coghlan3267a302012-05-21 22:54:43 +1000884``__enter__`` method (for example, synchronisation objects from the
885:mod:`threading` module).
886
887(:issue:`13585`)
888
889
Éric Araujo84b8ed82011-08-29 21:42:47 +0200890crypt
891-----
892
Victor Stinnerc78fb332011-09-21 03:35:44 +0200893Addition of salt and modular crypt format and the :func:`~crypt.mksalt`
894function to the :mod:`crypt` module.
Éric Araujo84b8ed82011-08-29 21:42:47 +0200895
896(:issue:`10924`)
897
Victor Stinnera7878b72011-07-14 23:07:44 +0200898curses
899------
900
Victor Stinner0fdfceb2011-11-25 22:10:02 +0100901 * If the :mod:`curses` module is linked to the ncursesw library, use Unicode
902 functions when Unicode strings or characters are passed (e.g.
903 :c:func:`waddwstr`), and bytes functions otherwise (e.g. :c:func:`waddstr`).
904 * Use the locale encoding instead of ``utf-8`` to encode Unicode strings.
905 * :class:`curses.window` has a new :attr:`curses.window.encoding` attribute.
Victor Stinnerc78fb332011-09-21 03:35:44 +0200906 * The :class:`curses.window` class has a new :meth:`~curses.window.get_wch`
907 method to get a wide character
908 * The :mod:`curses` module has a new :meth:`~curses.unget_wch` function to
909 push a wide character so the next :meth:`~curses.window.get_wch` will return
910 it
Victor Stinnera7878b72011-07-14 23:07:44 +0200911
Victor Stinnerc78fb332011-09-21 03:35:44 +0200912(Contributed by Iñigo Serna in :issue:`6755`)
Victor Stinnera7878b72011-07-14 23:07:44 +0200913
Stefan Krah1919b7e2012-03-21 18:25:23 +0100914decimal
915-------
916
917:issue:`7652` - integrate fast native decimal arithmetic.
918 C-module and libmpdec written by Stefan Krah.
919
920The new C version of the decimal module integrates the high speed libmpdec
Stefan Krahbf803082012-04-01 13:07:24 +0200921library for arbitrary precision correctly-rounded decimal floating point
922arithmetic. libmpdec conforms to IBM's General Decimal Arithmetic Specification.
Stefan Krah1919b7e2012-03-21 18:25:23 +0100923
Stefan Krah0c0914e2012-04-09 20:31:15 +0200924Performance gains range from 10x for database applications to 100x for
Stefan Krahbf803082012-04-01 13:07:24 +0200925numerically intensive applications. These numbers are expected gains
926for standard precisions used in decimal floating point arithmetic. Since
927the precision is user configurable, the exact figures may vary. For example,
928in integer bignum arithmetic the differences can be significantly higher.
929
930The following table is meant as an illustration. Benchmarks are available
Georg Brandl204e7892012-04-01 13:10:58 +0200931at http://www.bytereef.org/mpdecimal/quickstart.html.
Stefan Krah1919b7e2012-03-21 18:25:23 +0100932
933 +---------+-------------+--------------+-------------+
934 | | decimal.py | _decimal | speedup |
935 +=========+=============+==============+=============+
Stefan Krah0c0914e2012-04-09 20:31:15 +0200936 | pi | 38.89s | 0.38s | 100x |
Stefan Krah1919b7e2012-03-21 18:25:23 +0100937 +---------+-------------+--------------+-------------+
938 | telco | 172.19s | 5.68s | 30x |
939 +---------+-------------+--------------+-------------+
940 | psycopg | 3.57s | 0.29s | 12x |
941 +---------+-------------+--------------+-------------+
942
943Features
944~~~~~~~~
945
946* The :exc:`~decimal.FloatOperation` signal optionally enables stricter
947 semantics for mixing floats and Decimals.
948
949* If Python is compiled without threads, the C version automatically
950 disables the expensive thread local context machinery. In this case,
951 the variable :data:`~decimal.HAVE_THREADS` is set to False.
952
953API changes
954~~~~~~~~~~~
955
956* The C module has the following context limits, depending on the machine
957 architecture:
958
959 +-------------------+---------------------+------------------------------+
960 | | 32-bit | 64-bit |
961 +===================+=====================+==============================+
962 | :const:`MAX_PREC` | :const:`425000000` | :const:`999999999999999999` |
963 +-------------------+---------------------+------------------------------+
964 | :const:`MAX_EMAX` | :const:`425000000` | :const:`999999999999999999` |
965 +-------------------+---------------------+------------------------------+
966 | :const:`MIN_EMIN` | :const:`-425000000` | :const:`-999999999999999999` |
967 +-------------------+---------------------+------------------------------+
968
969* In the context templates (:class:`~decimal.DefaultContext`,
970 :class:`~decimal.BasicContext` and :class:`~decimal.ExtendedContext`)
971 the magnitude of :attr:`~decimal.Context.Emax` and
972 :attr:`~decimal.Context.Emin` has changed to :const:`999999`.
973
974* The :class:`~decimal.Decimal` constructor in decimal.py does not observe
975 the context limits and converts values with arbitrary exponents or precision
976 exactly. Since the C version has internal limits, the following scheme is
977 used: If possible, values are converted exactly, otherwise
978 :exc:`~decimal.InvalidOperation` is raised and the result is NaN. In the
979 latter case it is always possible to use :meth:`~decimal.Context.create_decimal`
980 in order to obtain a rounded or inexact value.
981
982
983* The power function in decimal.py is always correctly-rounded. In the
984 C version, it is defined in terms of the correctly-rounded
985 :meth:`~decimal.Decimal.exp` and :meth:`~decimal.Decimal.ln` functions,
986 but the final result is only "almost always correctly rounded".
987
988
989* In the C version, the context dictionary containing the signals is a
990 :class:`~collections.abc.MutableMapping`. For speed reasons,
991 :attr:`~decimal.Context.flags` and :attr:`~decimal.Context.traps` always
992 refer to the same :class:`~collections.abc.MutableMapping` that the context
993 was initialized with. If a new signal dictionary is assigned,
994 :attr:`~decimal.Context.flags` and :attr:`~decimal.Context.traps`
995 are updated with the new values, but they do not reference the RHS
996 dictionary.
997
998
999* Pickling a :class:`~decimal.Context` produces a different output in order
1000 to have a common interchange format for the Python and C versions.
1001
1002
1003* The order of arguments in the :class:`~decimal.Context` constructor has been
1004 changed to match the order displayed by :func:`repr`.
1005
1006
Victor Stinner024e37a2011-03-31 01:31:06 +02001007faulthandler
1008------------
1009
1010New module: :mod:`faulthandler`.
1011
1012 * :envvar:`PYTHONFAULTHANDLER`
1013 * :option:`-X` ``faulthandler``
1014
Victor Stinner811db3b2011-09-21 03:20:03 +02001015ftplib
1016------
1017
1018The :class:`~ftplib.FTP_TLS` class now provides a new
1019:func:`~ftplib.FTP_TLS.ccc` function to revert control channel back to
Florent Xicluna6d57d212011-10-23 22:23:57 +02001020plaintext. This can be useful to take advantage of firewalls that know how to
Victor Stinner811db3b2011-09-21 03:20:03 +02001021handle NAT with non-secure FTP without opening fixed ports.
1022
1023(Contributed by Giampaolo Rodolà in :issue:`12139`)
1024
1025
Antoine Pitrou5a8bc6f2011-11-17 02:20:48 +01001026imaplib
1027-------
1028
1029The :class:`~imaplib.IMAP4_SSL` constructor now accepts an SSLContext
1030parameter to control parameters of the secure channel.
1031
1032(Contributed by Sijin Joseph in :issue:`8808`)
1033
1034
Nick Coghlan2f92e542012-06-23 19:39:55 +10001035inspect
1036-------
1037
1038A new :func:`~inspect.getclosurevars` function has been added. This function
1039reports the current binding of all names referenced from the function body and
1040where those names were resolved, making it easier to verify correct internal
1041state when testing code that relies on stateful closures.
1042
1043(Contributed by Meador Inge and Nick Coghlan in :issue:`13062`)
1044
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001045A new :func:`~inspect.getgeneratorlocals` function has been added. This
1046function reports the current binding of local variables in the generator's
1047stack frame, making it easier to verify correct internal state when testing
1048generators.
1049
1050(Contributed by Meador Inge in :issue:`15153`)
1051
Charles-François Natalidc3044c2012-01-09 22:40:02 +01001052io
1053--
1054
Charles-François Natalid612de12012-01-14 11:51:00 +01001055The :func:`~io.open` function has a new ``'x'`` mode that can be used to
1056exclusively create a new file, and raise a :exc:`FileExistsError` if the file
1057already exists. It is based on the C11 'x' mode to fopen().
Charles-François Natalidc3044c2012-01-09 22:40:02 +01001058
1059(Contributed by David Townshend in :issue:`12760`)
1060
1061
Nick Coghlandc9b2552012-05-20 21:01:57 +10001062ipaddress
1063---------
1064
1065The new :mod:`ipaddress` module provides tools for creating and manipulating
1066objects representing IPv4 and IPv6 addresses, networks and interfaces (i.e.
1067an IP address associated with a specific IP subnet).
1068
1069(Contributed by Google and Peter Moody in :pep:`3144`)
1070
Nadeem Vawda34599222011-12-09 01:32:46 +02001071lzma
1072----
1073
1074The newly-added :mod:`lzma` module provides data compression and decompression
1075using the LZMA algorithm, including support for the ``.xz`` and ``.lzma``
1076file formats.
1077
1078(Contributed by Nadeem Vawda and Per Øyvind Karlsen in :issue:`6715`)
1079
1080
Victor Stinnerfa0e3d52011-05-09 01:01:09 +02001081math
1082----
1083
1084The :mod:`math` module has a new function:
1085
1086 * :func:`~math.log2`: return the base-2 logarithm of *x*
1087 (Written by Mark Dickinson in :issue:`11888`).
1088
1089
Antoine Pitrou9a864472012-05-04 23:15:47 +02001090multiprocessing
1091---------------
1092
1093The new :func:`multiprocessing.connection.wait` function allows to poll
1094multiple objects (such as connections, sockets and pipes) with a timeout.
1095(Contributed by Richard Oudkerk in :issue:`12328`.)
1096
1097:class:`multiprocessing.Connection` objects can now be transferred over
1098multiprocessing connections.
1099(Contributed by Richard Oudkerk in :issue:`4892`.)
1100
1101
Victor Stinnerfa0e3d52011-05-09 01:01:09 +02001102nntplib
1103-------
1104
1105The :class:`nntplib.NNTP` class now supports the context manager protocol to
1106unconditionally consume :exc:`socket.error` exceptions and to close the NNTP
1107connection when done::
1108
1109 >>> from nntplib import NNTP
Ezio Melotti3c14b4e2011-07-13 11:44:44 +03001110 >>> with NNTP('news.gmane.org') as n:
Victor Stinnerfa0e3d52011-05-09 01:01:09 +02001111 ... n.group('gmane.comp.python.committers')
1112 ...
Ezio Melotti04f648c2011-07-26 09:37:46 +03001113 ('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers')
Victor Stinnerfa0e3d52011-05-09 01:01:09 +02001114 >>>
1115
1116(Contributed by Giampaolo Rodolà in :issue:`9795`)
1117
1118
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001119os
1120--
1121
Charles-François Natalia003af12011-06-01 20:30:52 +02001122* The :mod:`os` module has a new :func:`~os.pipe2` function that makes it
1123 possible to create a pipe with :data:`~os.O_CLOEXEC` or
1124 :data:`~os.O_NONBLOCK` flags set atomically. This is especially useful to
1125 avoid race conditions in multi-threaded programs.
1126
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00001127* The :mod:`os` module has a new :func:`~os.sendfile` function which provides
1128 an efficent "zero-copy" way for copying data from one file (or socket)
1129 descriptor to another. The phrase "zero-copy" refers to the fact that all of
1130 the copying of data between the two descriptors is done entirely by the
1131 kernel, with no copying of data into userspace buffers. :func:`~os.sendfile`
1132 can be used to efficiently copy data from a file on disk to a network socket,
1133 e.g. for downloading a file.
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001134
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00001135 (Patch submitted by Ross Lagerwall and Giampaolo Rodolà in :issue:`10882`.)
1136
1137* The :mod:`os` module has two new functions: :func:`~os.getpriority` and
1138 :func:`~os.setpriority`. They can be used to get or set process
1139 niceness/priority in a fashion similar to :func:`os.nice` but extended to all
1140 processes instead of just the current one.
1141
1142 (Patch submitted by Giampaolo Rodolà in :issue:`10784`.)
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001143
Charles-François Natali7372b062012-02-05 15:15:38 +01001144* The :mod:`os` module has a new :func:`~os.fwalk` function similar to
1145 :func:`~os.walk` except that it also yields file descriptors referring to the
1146 directories visited. This is especially useful to avoid symlink races.
1147
Antoine Pitrou9a864472012-05-04 23:15:47 +02001148* The new :func:`os.replace` function allows cross-platform renaming of a
1149 file with overwriting the destination. With :func:`os.rename`, an existing
1150 destination file is overwritten under POSIX, but raises an error under
1151 Windows.
1152 (Contributed by Antoine Pitrou in :issue:`8828`.)
1153
1154* The new :func:`os.get_terminal_size` function queries the size of the
1155 terminal attached to a file descriptor.
1156 (Contributed by Zbigniew Jędrzejewski-Szmek in :issue:`13609`.)
1157
Victor Stinnere5064372011-10-14 00:08:29 +02001158* "at" functions (:issue:`4761`):
1159
1160 * :func:`~os.faccessat`
1161 * :func:`~os.fchmodat`
1162 * :func:`~os.fchownat`
1163 * :func:`~os.fstatat`
1164 * :func:`~os.futimesat`
Victor Stinnere5064372011-10-14 00:08:29 +02001165 * :func:`~os.linkat`
1166 * :func:`~os.mkdirat`
1167 * :func:`~os.mkfifoat`
1168 * :func:`~os.mknodat`
1169 * :func:`~os.openat`
1170 * :func:`~os.readlinkat`
1171 * :func:`~os.renameat`
1172 * :func:`~os.symlinkat`
1173 * :func:`~os.unlinkat`
1174 * :func:`~os.utimensat`
Victor Stinnere5064372011-10-14 00:08:29 +02001175
1176* extended attributes (:issue:`12720`):
1177
1178 * :func:`~os.fgetxattr`
1179 * :func:`~os.flistxattr`
1180 * :func:`~os.fremovexattr`
1181 * :func:`~os.fsetxattr`
1182 * :func:`~os.getxattr`
1183 * :func:`~os.lgetxattr`
1184 * :func:`~os.listxattr`
1185 * :func:`~os.llistxattr`
1186 * :func:`~os.lremovexattr`
1187 * :func:`~os.lsetxattr`
1188 * :func:`~os.removexattr`
1189 * :func:`~os.setxattr`
1190
1191* Scheduler functions (:issue:`12655`):
1192
1193 * :func:`~os.sched_get_priority_max`
1194 * :func:`~os.sched_get_priority_min`
1195 * :func:`~os.sched_getaffinity`
1196 * :func:`~os.sched_getparam`
1197 * :func:`~os.sched_getscheduler`
1198 * :func:`~os.sched_rr_get_interval`
1199 * :func:`~os.sched_setaffinity`
1200 * :func:`~os.sched_setparam`
1201 * :func:`~os.sched_setscheduler`
1202 * :func:`~os.sched_yield`
1203
1204* Add some extra posix functions to the os module (:issue:`10812`):
1205
1206 * :func:`~os.fexecve`
1207 * :func:`~os.futimens`
Victor Stinnere5064372011-10-14 00:08:29 +02001208 * :func:`~os.futimes`
1209 * :func:`~os.lockf`
1210 * :func:`~os.lutimes`
Victor Stinnere5064372011-10-14 00:08:29 +02001211 * :func:`~os.posix_fadvise`
1212 * :func:`~os.posix_fallocate`
1213 * :func:`~os.pread`
1214 * :func:`~os.pwrite`
1215 * :func:`~os.readv`
1216 * :func:`~os.sync`
1217 * :func:`~os.truncate`
1218 * :func:`~os.waitid`
1219 * :func:`~os.writev`
1220
1221* Other new functions:
1222
Charles-François Natali77940902012-02-06 19:54:48 +01001223 * :func:`~os.flistdir` (:issue:`10755`)
Victor Stinnere5064372011-10-14 00:08:29 +02001224 * :func:`~os.getgrouplist` (:issue:`9344`)
1225
Giampaolo Rodolà424298a2011-03-03 18:34:06 +00001226
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001227pdb
1228---
1229
1230* Tab-completion is now available not only for command names, but also their
1231 arguments. For example, for the ``break`` command, function and file names
1232 are completed. (Contributed by Georg Brandl in :issue:`14210`)
1233
1234
Antoine Pitrou9a864472012-05-04 23:15:47 +02001235pickle
1236------
1237
1238:class:`pickle.Pickler` objects now have an optional
1239:attr:`~pickle.Pickler.dispatch_table` attribute allowing to set per-pickler
1240reduction functions.
1241(Contributed by Richard Oudkerk in :issue:`14166`.)
1242
1243
Victor Stinner383c3fc2011-05-25 01:35:05 +02001244pydoc
1245-----
1246
Victor Stinner6daa33c2011-05-25 01:41:22 +02001247The Tk GUI and the :func:`~pydoc.serve` function have been removed from the
1248:mod:`pydoc` module: ``pydoc -g`` and :func:`~pydoc.serve` have been deprecated
1249in Python 3.2.
Victor Stinner383c3fc2011-05-25 01:35:05 +02001250
1251
Antoine Pitrouad09b5d2012-06-24 22:41:33 +02001252re
1253--
1254
1255:class:`str` regular expressions now support ``\u`` and ``\U`` escapes.
1256
1257(Contributed by Serhiy Storchaka in :issue:`3665`.)
1258
1259
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001260sched
1261-----
Victor Stinner754851f2011-04-19 23:58:51 +02001262
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001263* :meth:`~sched.scheduler.run` now accepts a *blocking* parameter which when
1264 set to False makes the method execute the scheduled events due to expire
1265 soonest (if any) and then return immediately.
1266 This is useful in case you want to use the :class:`~sched.scheduler` in
1267 non-blocking applications. (Contributed by Giampaolo Rodolà in :issue:`13449`)
Victor Stinner754851f2011-04-19 23:58:51 +02001268
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001269* :class:`~sched.scheduler` class can now be safely used in multi-threaded
1270 environments. (Contributed by Josiah Carlson and Giampaolo Rodolà in
1271 :issue:`8684`)
1272
1273* *timefunc* and *delayfunct* parameters of :class:`~sched.scheduler` class
1274 constructor are now optional and defaults to :func:`time.time` and
1275 :func:`time.sleep` respectively. (Contributed by Chris Clark in
1276 :issue:`13245`)
1277
1278* :meth:`~sched.scheduler.enter` and :meth:`~sched.scheduler.enterabs`
1279 *argument* parameter is now optional. (Contributed by Chris Clark in
1280 :issue:`13245`)
1281
1282* :meth:`~sched.scheduler.enter` and :meth:`~sched.scheduler.enterabs`
1283 now accept a *kwargs* parameter. (Contributed by Chris Clark in
1284 :issue:`13245`)
1285
1286
1287shutil
1288------
1289
1290* The :mod:`shutil` module has these new fuctions:
1291
1292 * :func:`~shutil.disk_usage`: provides total, used and free disk space
1293 statistics. (Contributed by Giampaolo Rodolà in :issue:`12442`)
1294 * :func:`~shutil.chown`: allows one to change user and/or group of the given
1295 path also specifying the user/group names and not only their numeric
1296 ids. (Contributed by Sandro Tosi in :issue:`12191`)
Victor Stinnera9293352011-04-30 15:21:58 +02001297
Antoine Pitrou9a864472012-05-04 23:15:47 +02001298* The new :func:`shutil.get_terminal_size` function returns the size of the
1299 terminal window the interpreter is attached to.
1300 (Contributed by Zbigniew Jędrzejewski-Szmek in :issue:`13609`.)
1301
1302* Several functions now take an optional ``symlinks`` argument: when that
1303 parameter is true, symlinks aren't dereferenced and the operation instead
1304 acts on the symlink itself (or creates one, if relevant).
1305 (Contributed by Hynek Schlawack in :issue:`12715`.)
1306
Nick Coghlan5b0eca12012-06-24 16:43:06 +10001307* :func:`~shutil.rmtree` is now resistant to symlink attacks on platforms
1308 which support the new ``dir_fd`` parameter in :func:`os.open` and
1309 :func:`os.unlinkat`. (Contributed by Martin von Löwis and Hynek Schlawack
1310 in :issue:`4489`.)
1311
Antoine Pitrou9a864472012-05-04 23:15:47 +02001312
Victor Stinnerfa0e3d52011-05-09 01:01:09 +02001313
Victor Stinnera9293352011-04-30 15:21:58 +02001314signal
1315------
1316
Victor Stinnerfa0e3d52011-05-09 01:01:09 +02001317* The :mod:`signal` module has new functions:
Victor Stinnera9293352011-04-30 15:21:58 +02001318
Victor Stinnerb3e72192011-05-08 01:46:11 +02001319 * :func:`~signal.pthread_sigmask`: fetch and/or change the signal mask of the
1320 calling thread (Contributed by Jean-Paul Calderone in :issue:`8407`) ;
1321 * :func:`~signal.pthread_kill`: send a signal to a thread ;
1322 * :func:`~signal.sigpending`: examine pending functions ;
1323 * :func:`~signal.sigwait`: wait a signal.
Ross Lagerwallbc808222011-06-25 12:13:40 +02001324 * :func:`~signal.sigwaitinfo`: wait for a signal, returning detailed
1325 information about it.
1326 * :func:`~signal.sigtimedwait`: like :func:`~signal.sigwaitinfo` but with a
1327 timeout.
Victor Stinnera9293352011-04-30 15:21:58 +02001328
Victor Stinnerd49b1f12011-05-08 02:03:15 +02001329* The signal handler writes the signal number as a single byte instead of
1330 a nul byte into the wakeup file descriptor. So it is possible to wait more
1331 than one signal and know which signals were raised.
1332
Victor Stinner388196e2011-05-10 17:13:00 +02001333* :func:`signal.signal` and :func:`signal.siginterrupt` raise an OSError,
1334 instead of a RuntimeError: OSError has an errno attribute.
1335
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001336smtplib
1337-------
1338
1339The :class:`~smtplib.SMTP_SSL` constructor and the :meth:`~smtplib.SMTP.starttls`
1340method now accept an SSLContext parameter to control parameters of the secure
1341channel.
1342
1343(Contributed by Kasun Herath in :issue:`8809`)
1344
1345
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001346socket
1347------
1348
Charles-François Natali47413c12011-10-06 19:47:44 +02001349* The :class:`~socket.socket` class now exposes additional methods to process
1350 ancillary data when supported by the underlying platform:
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001351
Charles-François Natali47413c12011-10-06 19:47:44 +02001352 * :func:`~socket.socket.sendmsg`
1353 * :func:`~socket.socket.recvmsg`
1354 * :func:`~socket.socket.recvmsg_into`
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001355
Charles-François Natali47413c12011-10-06 19:47:44 +02001356 (Contributed by David Watson in :issue:`6560`, based on an earlier patch by
1357 Heiko Wundram)
1358
1359* The :class:`~socket.socket` class now supports the PF_CAN protocol family
1360 (http://en.wikipedia.org/wiki/Socketcan), on Linux
1361 (http://lwn.net/Articles/253425).
1362
1363 (Contributed by Matthias Fuchs, updated by Tiago Gonçalves in :issue:`10141`)
1364
Charles-François Natali10b8cf42011-11-10 19:21:37 +01001365* The :class:`~socket.socket` class now supports the PF_RDS protocol family
1366 (http://en.wikipedia.org/wiki/Reliable_Datagram_Sockets and
1367 http://oss.oracle.com/projects/rds/).
Victor Stinner754851f2011-04-19 23:58:51 +02001368
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001369
Victor Stinner99c8b162011-05-24 12:05:19 +02001370ssl
1371---
1372
Antoine Pitrou2c0a9672011-11-17 02:09:13 +01001373* The :mod:`ssl` module has two new random generation functions:
Victor Stinner99c8b162011-05-24 12:05:19 +02001374
1375 * :func:`~ssl.RAND_bytes`: generate cryptographically strong
1376 pseudo-random bytes.
1377 * :func:`~ssl.RAND_pseudo_bytes`: generate pseudo-random bytes.
1378
Antoine Pitrou2c0a9672011-11-17 02:09:13 +01001379 (Contributed by Victor Stinner in :issue:`12049`)
1380
1381* The :mod:`ssl` module now exposes a finer-grained exception hierarchy
1382 in order to make it easier to inspect the various kinds of errors.
1383
1384 (Contributed by Antoine Pitrou in :issue:`11183`)
1385
1386* :meth:`~ssl.SSLContext.load_cert_chain` now accepts a *password* argument
1387 to be used if the private key is encrypted.
1388
1389 (Contributed by Adam Simpkins in :issue:`12803`)
1390
Antoine Pitrou73fc8142011-12-23 20:58:36 +01001391* Diffie-Hellman key exchange, both regular and Elliptic Curve-based, is
1392 now supported through the :meth:`~ssl.SSLContext.load_dh_params` and
1393 :meth:`~ssl.SSLContext.set_ecdh_curve` methods.
1394
1395 (Contributed by Antoine Pitrou in :issue:`13626` and :issue:`13627`)
1396
Antoine Pitrou2c0a9672011-11-17 02:09:13 +01001397* SSL sockets have a new :meth:`~ssl.SSLSocket.get_channel_binding` method
1398 allowing the implementation of certain authentication mechanisms such as
1399 SCRAM-SHA-1-PLUS.
1400
1401 (Contributed by Jacek Konieczny in :issue:`12551`)
1402
Antoine Pitrou73fc8142011-12-23 20:58:36 +01001403* You can query the SSL compression algorithm used by an SSL socket, thanks
1404 to its new :meth:`~ssl.SSLSocket.compression` method.
1405
1406 (Contributed by Antoine Pitrou in :issue:`13634`)
1407
Antoine Pitrou9a864472012-05-04 23:15:47 +02001408* Support has been added for the Next Procotol Negotiation extension using
1409 the :meth:`ssl.SSLContext.set_npn_protocols` method.
1410
1411 (Contributed by Colin Marc in :issue:`14204`)
1412
Antoine Pitrouad09b5d2012-06-24 22:41:33 +02001413* SSL errors can now be introspected more easily thanks to
1414 :attr:`~ssl.SSLError.library` and :attr:`~ssl.SSLError.reason` attributes.
1415
1416 (Contributed by Antoine Pitrou in :issue:`14837`)
1417
Giampaolo Rodola'ffa1d0b2012-05-15 15:30:25 +02001418stat
1419----
1420
1421- The undocumented tarfile.filemode function has been moved to
1422 :func:`stat.filemode`. It can be used to convert a file's mode to a string of
1423 the form '-rwxrwxrwx'.
1424
1425 (Contributed by Giampaolo Rodolà in :issue:`14807`)
Antoine Pitrou73fc8142011-12-23 20:58:36 +01001426
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001427sys
1428---
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02001429
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001430* The :mod:`sys` module has a new :data:`~sys.thread_info` :term:`struct
1431 sequence` holding informations about the thread implementation.
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02001432
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001433 (:issue:`11223`)
Giampaolo Rodola'096dcb12011-06-27 11:17:51 +02001434
Nick Coghlan4fae8cd2012-06-11 23:07:51 +10001435textwrap
1436--------
1437
1438* The :mod:`textwrap` module has a new :func:`~textwrap.indent` that makes
1439 it straightforward to add a common prefix to selected lines in a block
1440 of text.
1441
1442 (:issue:`13857`)
Antoine Pitrou5a8bc6f2011-11-17 02:20:48 +01001443
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001444time
1445----
Antoine Pitrou5a8bc6f2011-11-17 02:20:48 +01001446
Victor Stinnerec895392012-04-29 02:41:27 +02001447The :pep:`418` added new functions to the :mod:`time` module:
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001448
Victor Stinnerec895392012-04-29 02:41:27 +02001449* :func:`~time.get_clock_info`: Get information on a clock.
1450* :func:`~time.monotonic`: Monotonic clock (cannot go backward), not affected
1451 by system clock updates.
1452* :func:`~time.perf_counter`: Performance counter with the highest available
1453 resolution to measure a short duration.
1454* :func:`~time.process_time`: Sum of the system and user CPU time of the
1455 current process.
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001456
Victor Stinnerec895392012-04-29 02:41:27 +02001457Other new functions:
1458
1459* :func:`~time.clock_getres`, :func:`~time.clock_gettime` and
1460 :func:`~time.clock_settime` functions with ``CLOCK_xxx`` constants.
1461 (Contributed by Victor Stinner in :issue:`10278`)
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001462
Antoine Pitrou5a8bc6f2011-11-17 02:20:48 +01001463
Victor Stinner0db176f2012-04-16 00:16:30 +02001464types
1465-----
1466
1467Add a new :class:`types.MappingProxyType` class: Read-only proxy of a mapping.
1468(:issue:`14386`)
1469
1470
Nick Coghlan7fc570a2012-05-20 02:34:13 +10001471The new functions `types.new_class` and `types.prepare_class` provide support
1472for PEP 3115 compliant dynamic type creation. (:issue:`14588`)
1473
1474
Senthil Kumarande49d642011-10-16 23:54:44 +08001475urllib
1476------
1477
1478The :class:`~urllib.request.Request` class, now accepts a *method* argument
1479used by :meth:`~urllib.request.Request.get_method` to determine what HTTP method
Senthil Kumarana41c9422011-10-20 02:37:08 +08001480should be used. For example, this will send a ``'HEAD'`` request::
Senthil Kumarande49d642011-10-16 23:54:44 +08001481
1482 >>> urlopen(Request('http://www.python.org', method='HEAD'))
1483
1484(:issue:`1673007`)
Giampaolo Rodola'096dcb12011-06-27 11:17:51 +02001485
Giampaolo Rodola'be55d992011-11-22 13:33:34 +01001486
Éric Araujo4f61a2d2012-04-04 23:01:01 -04001487webbrowser
1488----------
1489
1490The :mod:`webbrowser` module supports more browsers: Google Chrome (named
1491:program:`chrome`, :program:`chromium`, :program:`chrome-browser` or
1492:program:`chromium-browser` depending on the version and operating system) as
1493well as the the generic launchers :program:`xdg-open` from the FreeDesktop.org
1494project and :program:`gvfs-open` which is the default URI handler for GNOME 3.
1495
1496(:issue:`13620` and :issue:`14493`)
1497
1498
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001499Optimizations
1500=============
1501
1502Major performance enhancements have been added:
1503
Éric Araujo4f61a2d2012-04-04 23:01:01 -04001504* Thanks to :pep:`393`, some operations on Unicode strings have been optimized:
Victor Stinner46606ce2011-11-20 18:27:55 +01001505
1506 * the memory footprint is divided by 2 to 4 depending on the text
Victor Stinnera996f1e2011-11-21 13:14:43 +01001507 * encode an ASCII string to UTF-8 doesn't need to encode characters anymore,
1508 the UTF-8 representation is shared with the ASCII representation
Victor Stinner6099a032011-12-18 14:22:26 +01001509 * the UTF-8 encoder has been optimized
1510 * repeating a single ASCII letter and getting a substring of a ASCII strings
1511 is 4 times faster
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001512
Antoine Pitrou5d7e1d32012-06-24 22:38:23 +02001513* UTF-8 is now 2x to 4x faster. UTF-16 encoding is now up to 10x faster.
Antoine Pitrou5cec9d22012-05-17 17:37:02 +02001514
Antoine Pitrouc9092962012-06-15 22:22:18 +02001515 (contributed by Serhiy Storchaka, :issue:`14624`, :issue:`14738` and
1516 :issue:`15026`.)
Antoine Pitrou5cec9d22012-05-17 17:37:02 +02001517
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001518
1519Build and C API Changes
1520=======================
1521
1522Changes to Python's build process and to the C API include:
1523
Stefan Krah95b1ba62012-02-29 17:27:21 +01001524* New :pep:`3118` related function:
1525
1526 * :c:func:`PyMemoryView_FromMemory`
1527
Éric Araujo4f61a2d2012-04-04 23:01:01 -04001528* :pep:`393` added new Unicode types, macros and functions:
Victor Stinner46606ce2011-11-20 18:27:55 +01001529
Victor Stinnera996f1e2011-11-21 13:14:43 +01001530 * High-level API:
1531
1532 * :c:func:`PyUnicode_CopyCharacters`
1533 * :c:func:`PyUnicode_FindChar`
1534 * :c:func:`PyUnicode_GetLength`, :c:macro:`PyUnicode_GET_LENGTH`
1535 * :c:func:`PyUnicode_New`
1536 * :c:func:`PyUnicode_Substring`
1537 * :c:func:`PyUnicode_ReadChar`, :c:func:`PyUnicode_WriteChar`
1538
1539 * Low-level API:
1540
1541 * :c:type:`Py_UCS1`, :c:type:`Py_UCS2`, :c:type:`Py_UCS4` types
1542 * :c:type:`PyASCIIObject` and :c:type:`PyCompactUnicodeObject` structures
1543 * :c:macro:`PyUnicode_READY`
1544 * :c:func:`PyUnicode_FromKindAndData`
1545 * :c:func:`PyUnicode_AsUCS4`, :c:func:`PyUnicode_AsUCS4Copy`
1546 * :c:macro:`PyUnicode_DATA`, :c:macro:`PyUnicode_1BYTE_DATA`,
1547 :c:macro:`PyUnicode_2BYTE_DATA`, :c:macro:`PyUnicode_4BYTE_DATA`
1548 * :c:macro:`PyUnicode_KIND` with :c:type:`PyUnicode_Kind` enum:
1549 :c:data:`PyUnicode_WCHAR_KIND`, :c:data:`PyUnicode_1BYTE_KIND`,
1550 :c:data:`PyUnicode_2BYTE_KIND`, :c:data:`PyUnicode_4BYTE_KIND`
1551 * :c:macro:`PyUnicode_READ`, :c:macro:`PyUnicode_READ_CHAR`, :c:macro:`PyUnicode_WRITE`
1552 * :c:macro:`PyUnicode_MAX_CHAR_VALUE`
1553
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001554
1555
Victor Stinnerd1be8782011-12-09 00:10:41 +01001556Deprecated
1557==========
1558
Georg Brandl0cd25c92011-04-29 13:45:54 +02001559Unsupported Operating Systems
Victor Stinnerd1be8782011-12-09 00:10:41 +01001560-----------------------------
Victor Stinnerb90db4c2011-04-26 22:48:24 +02001561
Brian Curtin49a40cd2011-05-02 22:30:06 -05001562OS/2 and VMS are no longer supported due to the lack of a maintainer.
1563
1564Windows 2000 and Windows platforms which set ``COMSPEC`` to ``command.com``
1565are no longer supported due to maintenance burden.
Victor Stinnerb90db4c2011-04-26 22:48:24 +02001566
1567
Victor Stinner46606ce2011-11-20 18:27:55 +01001568Deprecated Python modules, functions and methods
Victor Stinnerd1be8782011-12-09 00:10:41 +01001569------------------------------------------------
Victor Stinner19bd0692011-11-16 00:18:57 +01001570
Victor Stinner19bd0692011-11-16 00:18:57 +01001571* The ``unicode_internal`` codec has been deprecated because of the
Sandro Tosicd899122012-01-22 12:16:04 +01001572 :pep:`393`, use UTF-8, UTF-16 (``utf-16-le`` or ``utf-16-be``), or UTF-32
1573 (``utf-32-le`` or ``utf-32-be``)
Victor Stinner19bd0692011-11-16 00:18:57 +01001574* :meth:`ftplib.FTP.nlst` and :meth:`ftplib.FTP.dir`: use
Victor Stinner46606ce2011-11-20 18:27:55 +01001575 :meth:`ftplib.FTP.mlsd`
Victor Stinner19bd0692011-11-16 00:18:57 +01001576* :func:`platform.popen`: use the :mod:`subprocess` module. Check especially
1577 the :ref:`subprocess-replacements` section.
1578* :issue:`13374`: The Windows bytes API has been deprecated in the :mod:`os`
Victor Stinner46606ce2011-11-20 18:27:55 +01001579 module. Use Unicode filenames, instead of bytes filenames, to not depend on
Victor Stinner19bd0692011-11-16 00:18:57 +01001580 the ANSI code page anymore and to support any filename.
Florent Xiclunaa72a98f2012-02-13 11:03:30 +01001581* :issue:`13988`: The :mod:`xml.etree.cElementTree` module is deprecated. The
1582 accelerator is used automatically whenever available.
Victor Stinner47620a62012-04-29 02:52:39 +02001583* The behaviour of :func:`time.clock` depends on the platform: use the new
1584 :func:`time.perf_counter` or :func:`time.process_time` function instead,
1585 depending on your requirements, to have a well defined behaviour.
Victor Stinner19bd0692011-11-16 00:18:57 +01001586
1587
Victor Stinner46606ce2011-11-20 18:27:55 +01001588Deprecated functions and types of the C API
Victor Stinnerd1be8782011-12-09 00:10:41 +01001589-------------------------------------------
Victor Stinner46606ce2011-11-20 18:27:55 +01001590
Éric Araujo4f61a2d2012-04-04 23:01:01 -04001591The :c:type:`Py_UNICODE` has been deprecated by :pep:`393` and will be
Victor Stinner46606ce2011-11-20 18:27:55 +01001592removed in Python 4. All functions using this type are deprecated:
1593
Victor Stinner46606ce2011-11-20 18:27:55 +01001594Unicode functions and methods using :c:type:`Py_UNICODE` and
1595:c:type:`Py_UNICODE*` types:
1596
1597 * :c:macro:`PyUnicode_FromUnicode`: use :c:func:`PyUnicode_FromWideChar` or
1598 :c:func:`PyUnicode_FromKindAndData`
1599 * :c:macro:`PyUnicode_AS_UNICODE`, :c:func:`PyUnicode_AsUnicode`,
1600 :c:func:`PyUnicode_AsUnicodeAndSize`: use :c:func:`PyUnicode_AsWideCharString`
1601 * :c:macro:`PyUnicode_AS_DATA`: use :c:macro:`PyUnicode_DATA` with
1602 :c:macro:`PyUnicode_READ` and :c:macro:`PyUnicode_WRITE`
1603 * :c:macro:`PyUnicode_GET_SIZE`, :c:func:`PyUnicode_GetSize`: use
1604 :c:macro:`PyUnicode_GET_LENGTH` or :c:func:`PyUnicode_GetLength`
1605 * :c:macro:`PyUnicode_GET_DATA_SIZE`: use
1606 ``PyUnicode_GET_LENGTH(str) * PyUnicode_KIND(str)`` (only work on ready
1607 strings)
Victor Stinnerbf6e5602011-12-12 01:53:47 +01001608 * :c:func:`PyUnicode_AsUnicodeCopy`: use :c:func:`PyUnicode_AsUCS4Copy` or
1609 :c:func:`PyUnicode_AsWideCharString`
Victor Stinnerab595942011-12-17 04:59:06 +01001610 * :c:func:`PyUnicode_GetMax`
1611
Victor Stinner46606ce2011-11-20 18:27:55 +01001612
Victor Stinnera996f1e2011-11-21 13:14:43 +01001613Functions and macros manipulating Py_UNICODE* strings:
1614
1615 * :c:macro:`Py_UNICODE_strlen`: use :c:func:`PyUnicode_GetLength` or
1616 :c:macro:`PyUnicode_GET_LENGTH`
1617 * :c:macro:`Py_UNICODE_strcat`: use :c:func:`PyUnicode_CopyCharacters` or
1618 :c:func:`PyUnicode_FromFormat`
1619 * :c:macro:`Py_UNICODE_strcpy`, :c:macro:`Py_UNICODE_strncpy`,
1620 :c:macro:`Py_UNICODE_COPY`: use :c:func:`PyUnicode_CopyCharacters` or
1621 :c:func:`PyUnicode_Substring`
1622 * :c:macro:`Py_UNICODE_strcmp`: use :c:func:`PyUnicode_Compare`
1623 * :c:macro:`Py_UNICODE_strncmp`: use :c:func:`PyUnicode_Tailmatch`
1624 * :c:macro:`Py_UNICODE_strchr`, :c:macro:`Py_UNICODE_strrchr`: use
1625 :c:func:`PyUnicode_FindChar`
Victor Stinner606e19d2012-01-04 03:59:16 +01001626 * :c:macro:`Py_UNICODE_FILL`: use :c:func:`PyUnicode_Fill`
Victor Stinnerab595942011-12-17 04:59:06 +01001627 * :c:macro:`Py_UNICODE_MATCH`
Victor Stinnera996f1e2011-11-21 13:14:43 +01001628
Victor Stinner46606ce2011-11-20 18:27:55 +01001629Encoders:
1630
1631 * :c:func:`PyUnicode_Encode`: use :c:func:`PyUnicode_AsEncodedObject`
1632 * :c:func:`PyUnicode_EncodeUTF7`
Victor Stinnera996f1e2011-11-21 13:14:43 +01001633 * :c:func:`PyUnicode_EncodeUTF8`: use :c:func:`PyUnicode_AsUTF8` or
1634 :c:func:`PyUnicode_AsUTF8String`
Victor Stinner46606ce2011-11-20 18:27:55 +01001635 * :c:func:`PyUnicode_EncodeUTF32`
1636 * :c:func:`PyUnicode_EncodeUTF16`
1637 * :c:func:`PyUnicode_EncodeUnicodeEscape:` use
1638 :c:func:`PyUnicode_AsUnicodeEscapeString`
1639 * :c:func:`PyUnicode_EncodeRawUnicodeEscape:` use
1640 :c:func:`PyUnicode_AsRawUnicodeEscapeString`
1641 * :c:func:`PyUnicode_EncodeLatin1`: use :c:func:`PyUnicode_AsLatin1String`
1642 * :c:func:`PyUnicode_EncodeASCII`: use :c:func:`PyUnicode_AsASCIIString`
1643 * :c:func:`PyUnicode_EncodeCharmap`
1644 * :c:func:`PyUnicode_TranslateCharmap`
1645 * :c:func:`PyUnicode_EncodeMBCS`: use :c:func:`PyUnicode_AsMBCSString` or
1646 :c:func:`PyUnicode_EncodeCodePage` (with ``CP_ACP`` code_page)
1647 * :c:func:`PyUnicode_EncodeDecimal`,
1648 :c:func:`PyUnicode_TransformDecimalToASCII`
1649
1650
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001651Porting to Python 3.3
1652=====================
1653
1654This section lists previously described changes and other bugfixes
Antoine Pitrou037ffbf2011-10-24 00:25:41 +02001655that may require changes to your code.
1656
1657Porting Python code
1658-------------------
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001659
Georg Brandld6c43402012-03-07 08:55:52 +01001660.. XXX add a point about hash randomization and that it's always on in 3.3
1661
Victor Stinner19bd0692011-11-16 00:18:57 +01001662* :issue:`12326`: On Linux, sys.platform doesn't contain the major version
Victor Stinnerff3d9392011-08-20 23:39:26 +02001663 anymore. It is now always 'linux', instead of 'linux2' or 'linux3' depending
1664 on the Linux version used to build Python. Replace sys.platform == 'linux2'
1665 with sys.platform.startswith('linux'), or directly sys.platform == 'linux' if
1666 you don't need to support older Python versions.
Éric Araujoc09fca62011-03-23 02:06:24 +01001667
Victor Stinnerecc6e662012-03-14 00:39:29 +01001668* :issue:`13847`, :issue:`14180`: :mod:`time` and :mod:`datetime`:
1669 :exc:`OverflowError` is now raised instead of :exc:`ValueError` if a
1670 timestamp is out of range. :exc:`OSError` is now raised if C functions
1671 :c:func:`gmtime` or :c:func:`localtime` failed.
1672
Brett Cannonc2043482012-04-29 20:59:41 -04001673* The default finders used by import now utilize a cache of what is contained
1674 within a specific directory. If you create a Python source file or sourceless
1675 bytecode file, make sure to call :func:`importlib.invalidate_caches` to clear
1676 out the cache for the finders to notice the new file.
1677
1678* :exc:`ImportError` now uses the full name of the module that was attemped to
1679 be imported. Doctests that check ImportErrors' message will need to be
1680 updated to use the full name of the module instead of just the tail of the
1681 name.
1682
1683* The **index** argument to :func:`__import__` now defaults to 0 instead of -1
1684 and no longer support negative values. It was an oversight when :pep:`328` was
1685 implemented that the default value remained -1. If you need to continue to
1686 perform a relative import followed by an absolute import, then perform the
1687 relative import using an index of 1, followed by another import using an
1688 index of 0. It is preferred, though, that you use
1689 :func:`importlib.import_module` rather than call :func:`__import__` directly.
1690
1691* :func:`__import__` no longer allows one to use an index value other than 0
1692 for top-level modules. E.g. ``__import__('sys', level=1)`` is now an error.
1693
1694* Because :attr:`sys.meta_path` and :attr:`sys.path_hooks` now have finders on
1695 them by default, you will most likely want to use :meth:`list.insert` instead
1696 of :meth:`list.append` to add to those lists.
1697
1698* Because ``None`` is now inserted into :attr:`sys.path_importer_cache`, if you
1699 are clearing out entries in the dictionary of paths that do not have a
1700 finder, you will need to remove keys paired with values of ``None`` **and**
1701 :class:`imp.NullImporter` to be backwards-compatible. This will need to extra
1702 overhead on older versions of Python that re-insert ``None`` into
1703 :attr:`sys.path_importer_cache` where it repesents the use of implicit
1704 finders, but semantically it should not change anything.
1705
1706* :meth:`importlib.abc.SourceLoader.path_mtime` is now deprecated in favour of
1707 :meth:`importlib.abc.SourceLoader.path_stats` as bytecode files now store
1708 both the modification time and size of the source file the bytecode file was
1709 compiled from.
1710
1711
Antoine Pitrou037ffbf2011-10-24 00:25:41 +02001712Porting C code
1713--------------
1714
Stefan Krah54c32032012-02-29 17:47:21 +01001715* In the course of changes to the buffer API the undocumented
1716 :c:member:`~Py_buffer.smalltable` member of the
1717 :c:type:`Py_buffer` structure has been removed and the
1718 layout of the :c:type:`PyMemoryViewObject` has changed.
1719
1720 All extensions relying on the relevant parts in ``memoryobject.h``
1721 or ``object.h`` must be rebuilt.
1722
Antoine Pitrou037ffbf2011-10-24 00:25:41 +02001723* Due to :ref:`PEP 393 <pep-393>`, the :c:type:`Py_UNICODE` type and all
1724 functions using this type are deprecated (but will stay available for
1725 at least five years). If you were using low-level Unicode APIs to
1726 construct and access unicode objects and you want to benefit of the
Éric Araujo4f61a2d2012-04-04 23:01:01 -04001727 memory footprint reduction provided by PEP 393, you have to convert
Antoine Pitrou037ffbf2011-10-24 00:25:41 +02001728 your code to the new :doc:`Unicode API <../c-api/unicode>`.
1729
1730 However, if you only have been using high-level functions such as
1731 :c:func:`PyUnicode_Concat()`, :c:func:`PyUnicode_Join` or
1732 :c:func:`PyUnicode_FromFormat()`, your code will automatically take
1733 advantage of the new unicode representations.
1734
Antoine Pitrouc229e6e2012-02-20 19:41:11 +01001735Building C extensions
1736---------------------
1737
1738* The range of possible file names for C extensions has been narrowed.
1739 Very rarely used spellings have been suppressed: under POSIX, files
1740 named ``xxxmodule.so``, ``xxxmodule.abi3.so`` and
1741 ``xxxmodule.cpython-*.so`` are no longer recognized as implementing
1742 the ``xxx`` module. If you had been generating such files, you have
1743 to switch to the other spellings (i.e., remove the ``module`` string
1744 from the file names).
1745
1746 (implemented in :issue:`14040`.)
1747
1748
Antoine Pitrou037ffbf2011-10-24 00:25:41 +02001749Other issues
1750------------
1751
Éric Araujoc09fca62011-03-23 02:06:24 +01001752.. Issue #11591: When :program:`python` was started with :option:`-S`,
1753 ``import site`` will not add site-specific paths to the module search
1754 paths. In previous versions, it did. See changeset for doc changes in
1755 various files. Contributed by Carl Meyer with editions by Éric Araujo.
Éric Araujobe3bd572011-03-26 01:55:15 +01001756
Éric Araujobfc97292011-11-14 18:18:15 +01001757.. Issue #10998: the -Q command-line flag and related artifacts have been
Éric Araujobe3bd572011-03-26 01:55:15 +01001758 removed. Code checking sys.flags.division_warning will need updating.
1759 Contributed by Éric Araujo.