blob: 8bb0ded849ed468855c21d252feb83dd834e9991 [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.
Georg Brandl1d021732012-09-29 09:06:10 +020050Python 3.3 was released on September 29, 2012.
Giampaolo Rodolà3108f982011-02-24 20:59:48 +000051
Nick Coghlanb47b5392012-05-26 01:31:25 +100052
Antoine Pitrouc907de92012-08-21 00:53:06 +020053Summary -- Release highlights
54=============================
Victor Stinner636130e2012-08-05 16:37:12 +020055
Antoine Pitrouc907de92012-08-21 00:53:06 +020056.. This section singles out the most important changes in Python 3.3.
57 Brevity is key.
Victor Stinner636130e2012-08-05 16:37:12 +020058
Antoine Pitrouc907de92012-08-21 00:53:06 +020059New syntax features:
Victor Stinner636130e2012-08-05 16:37:12 +020060
Antoine Pitrouc907de92012-08-21 00:53:06 +020061* New ``yield from`` expression for :ref:`generator delegation <pep-380>`.
62* The ``u'unicode'`` syntax is accepted again for :class:`str` objects.
Victor Stinner636130e2012-08-05 16:37:12 +020063
Antoine Pitrouc907de92012-08-21 00:53:06 +020064New library modules:
65
66* :mod:`faulthandler` (helps debugging low-level crashes)
67* :mod:`ipaddress` (high-level objects representing IP addresses and masks)
68* :mod:`lzma` (compress data using the XZ / LZMA algorithm)
69* :mod:`venv` (Python :ref:`virtual environments <pep-405>`, as in the
70 popular ``virtualenv`` package)
71
72New built-in features:
73
74* Reworked :ref:`I/O exception hierarchy <pep-3151>`.
75
76Implementation improvements:
77
78* Rewritten :ref:`import machinery <importlib>` based on :mod:`importlib`.
79* More compact :ref:`unicode strings <pep-393>`.
80* More compact :ref:`attribute dictionaries <pep-412>`.
81
82Security improvements:
83
84* Hash randomization is switched on by default.
85
86Please read on for a comprehensive list of user-facing changes.
87
88
89.. _pep-405:
Victor Stinner636130e2012-08-05 16:37:12 +020090
Éric Araujo859aad62012-06-24 00:07:41 -040091PEP 405: Virtual Environments
92=============================
Nick Coghlanb47b5392012-05-26 01:31:25 +100093
Antoine Pitroua5e57972012-08-21 01:08:17 +020094:pep:`405` - Python Virtual Environments
95 PEP written by Carl Meyer, implemented by Carl Meyer and Vinay Sajip.
Nick Coghlanb47b5392012-05-26 01:31:25 +100096
Antoine Pitroua5e57972012-08-21 01:08:17 +020097Virtual environments help create separate Python setups while sharing a
98system-wide base install, for ease of maintenance. Virtual environments
99have their own set of private site packages (i.e. locally-installed
100libraries), and are optionally segregated from the system-wide site
101packages. Their concept and implementation are inspired by the popular
102``virtualenv`` third-party package, but benefit from tighter integration
103with the interpreter core.
Éric Araujo859aad62012-06-24 00:07:41 -0400104
Antoine Pitroua5e57972012-08-21 01:08:17 +0200105This PEP adds the :mod:`venv` module for programmatic access, and the
106:ref:`pyvenv <scripts-pyvenv>` script for command-line access and
107administration. The Python interpreter becomes aware of a ``pvenv.cfg``
108file whose existence signals the base of a virtual environment's directory
109tree.
Nick Coghlanb47b5392012-05-26 01:31:25 +1000110
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000111
Éric Araujo859aad62012-06-24 00:07:41 -0400112PEP 420: Namespace Packages
113===========================
114
115Native support for package directories that don't require ``__init__.py``
116marker files and can automatically span multiple path segments (inspired by
117various third party approaches to namespace packages, as described in
118:pep:`420`)
119
120
121.. _pep-3118-update:
Nick Coghlan98e20702012-03-06 21:50:13 +1000122
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100123PEP 3118: New memoryview implementation and buffer protocol documentation
124=========================================================================
125
126:issue:`10181` - memoryview bug fixes and features.
127 Written by Stefan Krah.
128
129The new memoryview implementation comprehensively fixes all ownership and
130lifetime issues of dynamically allocated fields in the Py_buffer struct
131that led to multiple crash reports. Additionally, several functions that
132crashed or returned incorrect results for non-contiguous or multi-dimensional
133input have been fixed.
134
135The memoryview object now has a PEP-3118 compliant getbufferproc()
136that checks the consumer's request type. Many new features have been
137added, most of them work in full generality for non-contiguous arrays
138and arrays with suboffsets.
139
140The documentation has been updated, clearly spelling out responsibilities
141for both exporters and consumers. Buffer request flags are grouped into
142basic and compound flags. The memory layout of non-contiguous and
143multi-dimensional NumPy-style arrays is explained.
144
145Features
146--------
147
148* All native single character format specifiers in struct module syntax
149 (optionally prefixed with '@') are now supported.
150
151* With some restrictions, the cast() method allows changing of format and
152 shape of C-contiguous arrays.
153
154* Multi-dimensional list representations are supported for any array type.
155
156* Multi-dimensional comparisons are supported for any array type.
157
Stefan Krah9e31d362012-09-08 15:35:01 +0200158* One-dimensional memoryviews of hashable (read-only) types with formats B,
159 b or c are now hashable. (Contributed by Antoine Pitrou in :issue:`13411`)
Nick Coghlan98e20702012-03-06 21:50:13 +1000160
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100161* Arbitrary slicing of any 1-D arrays type is supported. For example, it
162 is now possible to reverse a memoryview in O(1) by using a negative step.
163
164API changes
165-----------
166
167* The maximum number of dimensions is officially limited to 64.
168
169* The representation of empty shape, strides and suboffsets is now
170 an empty tuple instead of None.
171
172* Accessing a memoryview element with format 'B' (unsigned bytes)
173 now returns an integer (in accordance with the struct module syntax).
174 For returning a bytes object the view must be cast to 'c' first.
175
Nick Coghlan06e1ab02012-08-25 17:59:50 +1000176* memoryview comparisons now use the logical structure of the operands
177 and compare all array elements by value. All format strings in struct
178 module syntax are supported. Views with unrecognised format strings
179 are still permitted, but will always compare as unequal, regardless
180 of view contents.
181
Stefan Krah54c32032012-02-29 17:47:21 +0100182* For further changes see `Build and C API Changes`_ and `Porting C code`_ .
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100183
Antoine Pitrou037ffbf2011-10-24 00:25:41 +0200184.. _pep-393:
185
Ezio Melotti48a2f8f2011-09-29 00:18:19 +0300186PEP 393: Flexible String Representation
187=======================================
188
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200189The Unicode string type is changed to support multiple internal
190representations, depending on the character with the largest Unicode ordinal
191(1, 2, or 4 bytes) in the represented string. This allows a space-efficient
192representation in common cases, but gives access to full UCS-4 on all
193systems. For compatibility with existing APIs, several representations may
194exist in parallel; over time, this compatibility should be phased out.
Ezio Melotti397546a2011-09-29 08:34:36 +0300195
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200196On the Python side, there should be no downside to this change.
Ezio Melotti397546a2011-09-29 08:34:36 +0300197
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200198On the C API side, PEP 393 is fully backward compatible. The legacy API
199should remain available at least five years. Applications using the legacy
200API will not fully benefit of the memory reduction, or - worse - may use
201a bit more memory, because Python may have to maintain two versions of each
202string (in the legacy format and in the new efficient storage).
203
Antoine Pitrou0599b5b2011-11-29 22:45:07 +0100204Functionality
205-------------
206
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200207Changes introduced by :pep:`393` are the following:
Ezio Melotti48a2f8f2011-09-29 00:18:19 +0300208
Ezio Melotti397546a2011-09-29 08:34:36 +0300209* Python now always supports the full range of Unicode codepoints, including
210 non-BMP ones (i.e. from ``U+0000`` to ``U+10FFFF``). The distinction between
211 narrow and wide builds no longer exists and Python now behaves like a wide
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200212 build, even under Windows.
Ezio Melotti397546a2011-09-29 08:34:36 +0300213
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200214* With the death of narrow builds, the problems specific to narrow builds have
215 also been fixed, for example:
Ezio Melotti397546a2011-09-29 08:34:36 +0300216
217 * :func:`len` now always returns 1 for non-BMP characters,
218 so ``len('\U0010FFFF') == 1``;
219
220 * surrogate pairs are not recombined in string literals,
221 so ``'\uDBFF\uDFFF' != '\U0010FFFF'``;
222
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200223 * indexing or slicing non-BMP characters returns the expected value,
Ezio Melotti397546a2011-09-29 08:34:36 +0300224 so ``'\U0010FFFF'[0]`` now returns ``'\U0010FFFF'`` and not ``'\uDBFF'``;
225
Antoine Pitroud136aec2011-11-17 01:48:06 +0100226 * all other functions in the standard library now correctly handle
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200227 non-BMP codepoints.
Ezio Melotti397546a2011-09-29 08:34:36 +0300228
Ezio Melotti48a2f8f2011-09-29 00:18:19 +0300229* The value of :data:`sys.maxunicode` is now always ``1114111`` (``0x10FFFF``
230 in hexadecimal). The :c:func:`PyUnicode_GetMax` function still returns
231 either ``0xFFFF`` or ``0x10FFFF`` for backward compatibility, and it should
232 not be used with the new Unicode API (see :issue:`13054`).
233
Ezio Melotti397546a2011-09-29 08:34:36 +0300234* The :file:`./configure` flag ``--with-wide-unicode`` has been removed.
Victor Stinner7d637ab2011-09-29 02:56:16 +0200235
Antoine Pitrou0599b5b2011-11-29 22:45:07 +0100236Performance and resource usage
237------------------------------
238
239The storage of Unicode strings now depends on the highest codepoint in the string:
240
241* pure ASCII and Latin1 strings (``U+0000-U+00FF``) use 1 byte per codepoint;
242
243* BMP strings (``U+0000-U+FFFF``) use 2 bytes per codepoint;
244
245* non-BMP strings (``U+10000-U+10FFFF``) use 4 bytes per codepoint.
246
Martin v. Löwisde157cc2012-03-06 08:42:17 +0100247The net effect is that for most applications, memory usage of string
248storage should decrease significantly - especially compared to former
249wide unicode builds - as, in many cases, strings will be pure ASCII
250even in international contexts (because many strings store non-human
251language data, such as XML fragments, HTTP headers, JSON-encoded data,
252etc.). We also hope that it will, for the same reasons, increase CPU
253cache efficiency on non-trivial applications. The memory usage of
254Python 3.3 is two to three times smaller than Python 3.2, and a little
255bit better than Python 2.7, on a Django benchmark (see the PEP for
256details).
Antoine Pitrou0599b5b2011-11-29 22:45:07 +0100257
Éric Araujob07b97f2011-10-05 01:03:34 +0200258
Antoine Pitrouc907de92012-08-21 00:53:06 +0200259.. _pep-3151:
260
Victor Stinnera1bf2982011-10-12 20:35:02 +0200261PEP 3151: Reworking the OS and IO exception hierarchy
262=====================================================
263
264:pep:`3151` - Reworking the OS and IO exception hierarchy
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200265 PEP written and implemented by Antoine Pitrou.
Victor Stinnera1bf2982011-10-12 20:35:02 +0200266
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200267The hierarchy of exceptions raised by operating system errors is now both
268simplified and finer-grained.
Victor Stinnera1bf2982011-10-12 20:35:02 +0200269
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200270You don't have to worry anymore about choosing the appropriate exception
271type between :exc:`OSError`, :exc:`IOError`, :exc:`EnvironmentError`,
272:exc:`WindowsError`, :exc:`mmap.error`, :exc:`socket.error` or
273:exc:`select.error`. All these exception types are now only one:
274:exc:`OSError`. The other names are kept as aliases for compatibility
275reasons.
Victor Stinnera1bf2982011-10-12 20:35:02 +0200276
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200277Also, it is now easier to catch a specific error condition. Instead of
278inspecting the ``errno`` attribute (or ``args[0]``) for a particular
279constant from the :mod:`errno` module, you can catch the adequate
280:exc:`OSError` subclass. The available subclasses are the following:
Victor Stinnera1bf2982011-10-12 20:35:02 +0200281
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200282* :exc:`BlockingIOError`
283* :exc:`ChildProcessError`
284* :exc:`ConnectionError`
285* :exc:`FileExistsError`
286* :exc:`FileNotFoundError`
287* :exc:`InterruptedError`
288* :exc:`IsADirectoryError`
289* :exc:`NotADirectoryError`
290* :exc:`PermissionError`
291* :exc:`ProcessLookupError`
292* :exc:`TimeoutError`
Victor Stinnera1bf2982011-10-12 20:35:02 +0200293
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200294And the :exc:`ConnectionError` itself has finer-grained subclasses:
Victor Stinnera1bf2982011-10-12 20:35:02 +0200295
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200296* :exc:`BrokenPipeError`
297* :exc:`ConnectionAbortedError`
298* :exc:`ConnectionRefusedError`
299* :exc:`ConnectionResetError`
Victor Stinnera1bf2982011-10-12 20:35:02 +0200300
301Thanks to the new exceptions, common usages of the :mod:`errno` can now be
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200302avoided. For example, the following code written for Python 3.2::
Victor Stinnera1bf2982011-10-12 20:35:02 +0200303
304 from errno import ENOENT, EACCES, EPERM
305
306 try:
307 with open("document.txt") as f:
308 content = f.read()
309 except IOError as err:
310 if err.errno == ENOENT:
311 print("document.txt file is missing")
312 elif err.errno in (EACCES, EPERM):
313 print("You are not allowed to read document.txt")
314 else:
315 raise
316
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200317can now be written without the :mod:`errno` import and without manual
318inspection of exception attributes::
Victor Stinnera1bf2982011-10-12 20:35:02 +0200319
320 try:
321 with open("document.txt") as f:
322 content = f.read()
323 except FileNotFoundError:
324 print("document.txt file is missing")
325 except PermissionError:
326 print("You are not allowed to read document.txt")
327
328
Antoine Pitrouc907de92012-08-21 00:53:06 +0200329.. _pep-380:
330
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000331PEP 380: Syntax for Delegating to a Subgenerator
332================================================
333
Nick Coghlanab7bf212012-02-26 17:49:52 +1000334:pep:`380` - Syntax for Delegating to a Subgenerator
335 PEP written by Greg Ewing.
336
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000337PEP 380 adds the ``yield from`` expression, allowing a generator to delegate
338part of its operations to another generator. This allows a section of code
339containing 'yield' to be factored out and placed in another generator.
340Additionally, the subgenerator is allowed to return with a value, and the
341value is made available to the delegating generator.
Nick Coghlanb9b281b2012-03-06 22:31:12 +1000342
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000343While designed primarily for use in delegating to a subgenerator, the ``yield
344from`` expression actually allows delegation to arbitrary subiterators.
345
Nick Coghlanb9b281b2012-03-06 22:31:12 +1000346For simple iterators, ``yield from iterable`` is essentially just a shortened
347form of ``for item in iterable: yield item``::
348
349 >>> def g(x):
350 ... yield from range(x, 0, -1)
351 ... yield from range(x)
352 ...
353 >>> list(g(5))
354 [5, 4, 3, 2, 1, 0, 1, 2, 3, 4]
355
356However, unlike an ordinary loop, ``yield from`` allows subgenerators to
357receive sent and thrown values directly from the calling scope, and
358return a final value to the outer generator::
359
360 >>> def accumulate(start=0):
361 ... tally = start
362 ... while 1:
363 ... next = yield
364 ... if next is None:
365 ... return tally
366 ... tally += next
367 ...
368 >>> def gather_tallies(tallies, start=0):
369 ... while 1:
370 ... tally = yield from accumulate()
371 ... tallies.append(tally)
372 ...
373 >>> tallies = []
374 >>> acc = gather_tallies(tallies)
375 >>> next(acc) # Ensure the accumulator is ready to accept values
376 >>> for i in range(10):
377 ... acc.send(i)
378 ...
379 >>> acc.send(None) # Finish the first tally
380 >>> for i in range(5):
381 ... acc.send(i)
382 ...
383 >>> acc.send(None) # Finish the second tally
384 >>> tallies
385 [45, 10]
386
387The main principle driving this change is to allow even generators that are
388designed to be used with the ``send`` and ``throw`` methods to be split into
389multiple subgenerators as easily as a single large function can be split into
390multiple subfunctions.
391
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000392(Implementation by Greg Ewing, integrated into 3.3 by Renaud Blanch, Ryan
393Kelly and Nick Coghlan, documentation by Zbigniew Jędrzejewski-Szmek and
394Nick Coghlan)
395
396
Nick Coghlanab7bf212012-02-26 17:49:52 +1000397PEP 409: Suppressing exception context
398======================================
399
400:pep:`409` - Suppressing exception context
401 PEP written by Ethan Furman, implemented by Ethan Furman and Nick Coghlan.
402
403PEP 409 introduces new syntax that allows the display of the chained
404exception context to be disabled. This allows cleaner error messages in
405applications that convert between exception types::
406
407 >>> class D:
408 ... def __init__(self, extra):
409 ... self._extra_attributes = extra
410 ... def __getattr__(self, attr):
411 ... try:
412 ... return self._extra_attributes[attr]
413 ... except KeyError:
414 ... raise AttributeError(attr) from None
415 ...
416 >>> D({}).x
417 Traceback (most recent call last):
418 File "<stdin>", line 1, in <module>
419 File "<stdin>", line 8, in __getattr__
420 AttributeError: x
421
422Without the ``from None`` suffix to suppress the cause, the original
423exception would be displayed by default::
424
425 >>> class C:
426 ... def __init__(self, extra):
427 ... self._extra_attributes = extra
428 ... def __getattr__(self, attr):
429 ... try:
430 ... return self._extra_attributes[attr]
431 ... except KeyError:
432 ... raise AttributeError(attr)
433 ...
434 >>> C({}).x
435 Traceback (most recent call last):
436 File "<stdin>", line 6, in __getattr__
437 KeyError: 'x'
438
439 During handling of the above exception, another exception occurred:
440
441 Traceback (most recent call last):
442 File "<stdin>", line 1, in <module>
443 File "<stdin>", line 8, in __getattr__
444 AttributeError: x
445
446No debugging capability is lost, as the original exception context remains
447available if needed (for example, if an intervening library has incorrectly
448suppressed valuable underlying details)::
449
450 >>> try:
451 ... D({}).x
452 ... except AttributeError as exc:
453 ... print(repr(exc.__context__))
454 ...
455 KeyError('x',)
456
457
Nick Coghlan98e20702012-03-06 21:50:13 +1000458PEP 414: Explicit Unicode literals
459======================================
460
461:pep:`414` - Explicit Unicode literals
462 PEP written by Armin Ronacher.
463
464To ease the transition from Python 2 for Unicode aware Python applications
465that make heavy use of Unicode literals, Python 3.3 once again supports the
466"``u``" prefix for string literals. This prefix has no semantic significance
467in Python 3, it is provided solely to reduce the number of purely mechanical
468changes in migrating to Python 3, making it easier for developers to focus on
469the more significant semantic changes (such as the stricter default
470separation of binary and text data).
471
472
Antoine Pitrou6bbd76b2011-11-25 19:10:05 +0100473PEP 3155: Qualified name for classes and functions
474==================================================
475
476:pep:`3155` - Qualified name for classes and functions
477 PEP written and implemented by Antoine Pitrou.
478
479Functions and class objects have a new ``__qualname__`` attribute representing
480the "path" from the module top-level to their definition. For global functions
481and classes, this is the same as ``__name__``. For other functions and classes,
482it provides better information about where they were actually defined, and
483how they might be accessible from the global scope.
484
485Example with (non-bound) methods::
Nick Coghlan2dfe6b02012-01-14 14:19:49 +1000486
Antoine Pitrou6bbd76b2011-11-25 19:10:05 +0100487 >>> class C:
488 ... def meth(self):
489 ... pass
490 >>> C.meth.__name__
491 'meth'
492 >>> C.meth.__qualname__
493 'C.meth'
494
495Example with nested classes::
496
497 >>> class C:
498 ... class D:
499 ... def meth(self):
500 ... pass
501 ...
502 >>> C.D.__name__
503 'D'
504 >>> C.D.__qualname__
505 'C.D'
506 >>> C.D.meth.__name__
507 'meth'
508 >>> C.D.meth.__qualname__
509 'C.D.meth'
510
511Example with nested functions::
512
513 >>> def outer():
514 ... def inner():
515 ... pass
516 ... return inner
517 ...
518 >>> outer().__name__
519 'inner'
520 >>> outer().__qualname__
521 'outer.<locals>.inner'
522
Antoine Pitroue7ede062011-11-25 19:11:26 +0100523The string representation of those objects is also changed to include the
Antoine Pitrou6bbd76b2011-11-25 19:10:05 +0100524new, more precise information::
525
526 >>> str(C.D)
527 "<class '__main__.C.D'>"
528 >>> str(C.D.meth)
529 '<function C.D.meth at 0x7f46b9fe31e0>'
530
531
Antoine Pitrouc907de92012-08-21 00:53:06 +0200532.. _pep-412:
533
Antoine Pitroud94adb72012-07-07 17:33:42 +0200534PEP 412: Key-Sharing Dictionary
535===============================
536
537:pep:`412` - Key-Sharing Dictionary
538 PEP written and implemented by Mark Shannon.
539
540Dictionaries used for the storage of objects' attributes are now able to
541share part of their internal storage between each other (namely, the part
542which stores the keys and their respective hashes). This reduces the memory
543consumption of programs creating many instances of non-builtin types.
544
545
Andrew Svetlovac23c9e2012-08-13 21:27:56 +0300546PEP 362: Function Signature Object
547==================================
548
549:pep:`362`: - Function Signature Object
550 PEP written by Brett Cannon, Yury Selivanov, Larry Hastings, Jiwon Seo.
551 Implemented by Yury Selivanov.
552
553A new function :func:`inspect.signature` makes introspection of python
554callables easy and straightforward. A broad range of callables is supported:
555python functions, decorated or not, classes, and :func:`functools.partial`
556objects. New classes :class:`inspect.Signature`, :class:`inspect.Parameter`
557and :class:`inspect.BoundArguments` hold information about the call signatures,
558such as, annotations, default values, parameters kinds, and bound arguments,
559which considerably simplifies writing decorators and any code that validates
560or amends calling signatures or arguments.
561
562
Antoine Pitrouc907de92012-08-21 00:53:06 +0200563.. _importlib:
564
Brett Cannonc2043482012-04-29 20:59:41 -0400565Using importlib as the Implementation of Import
566===============================================
567:issue:`2377` - Replace __import__ w/ importlib.__import__
568:issue:`13959` - Re-implement parts of :mod:`imp` in pure Python
569:issue:`14605` - Make import machinery explicit
570:issue:`14646` - Require loaders set __loader__ and __package__
571
572(Written by Brett Cannon)
573
574The :func:`__import__` function is now powered by :func:`importlib.__import__`.
575This work leads to the completion of "phase 2" of :pep:`302`. There are
576multiple benefits to this change. First, it has allowed for more of the
577machinery powering import to be exposed instead of being implicit and hidden
578within the C code. It also provides a single implementation for all Python VMs
579supporting Python 3.3 to use, helping to end any VM-specific deviations in
580import semantics. And finally it eases the maintenance of import, allowing for
581future growth to occur.
582
583For the common user, this change should result in no visible change in
584semantics. Any possible changes required in one's code to handle this change
585should read the `Porting Python code`_ section of this document to see what
586needs to be changed, but it will only affect those that currently manipulate
587import or try calling it programmatically.
588
589New APIs
590--------
591One of the large benefits of this work is the exposure of what goes into
592making the import statement work. That means the various importers that were
593once implicit are now fully exposed as part of the :mod:`importlib` package.
594
Brett Cannon077ef452012-08-02 17:50:06 -0400595The abstract base classes defined in :mod:`importlib.abc` have been expanded
596to properly delineate between :term:`meta path finders <meta path finder>`
597and :term:`path entry finders <path entry finder>` by introducing
598:class:`importlib.abc.MetaPathFinder` and
599:class:`importlib.abc.PathEntryFinder`, respectively. The old ABC of
600:class:`importlib.abc.Finder` is now only provided for backwards-compatibility
601and does not enforce any method requirements.
602
603In terms of finders, :class:`importlib.machinery.FileFinder` exposes the
Brett Cannonc2043482012-04-29 20:59:41 -0400604mechanism used to search for source and bytecode files of a module. Previously
605this class was an implicit member of :attr:`sys.path_hooks`.
606
607For loaders, the new abstract base class :class:`importlib.abc.FileLoader` helps
608write a loader that uses the file system as the storage mechanism for a module's
609code. The loader for source files
610(:class:`importlib.machinery.SourceFileLoader`), sourceless bytecode files
611(:class:`importlib.machinery.SourcelessFileLoader`), and extension modules
612(:class:`importlib.machinery.ExtensionFileLoader`) are now available for
613direct use.
614
615:exc:`ImportError` now has ``name`` and ``path`` attributes which are set when
616there is relevant data to provide. The message for failed imports will also
617provide the full name of the module now instead of just the tail end of the
618module's name.
619
620The :func:`importlib.invalidate_caches` function will now call the method with
621the same name on all finders cached in :attr:`sys.path_importer_cache` to help
622clean up any stored state as necessary.
623
624Visible Changes
625---------------
626[For potential required changes to code, see the `Porting Python code`_
627section]
628
629Beyond the expanse of what :mod:`importlib` now exposes, there are other
630visible changes to import. The biggest is that :attr:`sys.meta_path` and
Brett Cannon077ef452012-08-02 17:50:06 -0400631:attr:`sys.path_hooks` now store all of the meta path finders and path entry
632hooks used by import. Previously the finders were implicit and hidden within
633the C code of import instead of being directly exposed. This means that one can
634now easily remove or change the order of the various finders to fit one's needs.
Brett Cannonc2043482012-04-29 20:59:41 -0400635
636Another change is that all modules have a ``__loader__`` attribute, storing the
637loader used to create the module. :pep:`302` has been updated to make this
638attribute mandatory for loaders to implement, so in the future once 3rd-party
639loaders have been updated people will be able to rely on the existence of the
640attribute. Until such time, though, import is setting the module post-load.
641
642Loaders are also now expected to set the ``__package__`` attribute from
643:pep:`366`. Once again, import itself is already setting this on all loaders
644from :mod:`importlib` and import itself is setting the attribute post-load.
645
646``None`` is now inserted into :attr:`sys.path_importer_cache` when no finder
647can be found on :attr:`sys.path_hooks`. Since :class:`imp.NullImporter` is not
648directly exposed on :attr:`sys.path_hooks` it could no longer be relied upon to
649always be available to use as a value representing no finder found.
650
651All other changes relate to semantic changes which should be taken into
652consideration when updating code for Python 3.3, and thus should be read about
653in the `Porting Python code`_ section of this document.
654
655
R David Murray0fa2edd2012-05-25 17:59:56 -0400656New Email Package Features
657==========================
658
R David Murraycb448cf2012-05-25 22:25:56 -0400659Policy Framework
660----------------
661
R David Murray0fa2edd2012-05-25 17:59:56 -0400662The email package now has a :mod:`~email.policy` framework. A
663:class:`~email.policy.Policy` is an object with several methods and properties
664that control how the email package behaves. The primary policy for Python 3.3
665is the :class:`~email.policy.Compat32` policy, which provides backward
666compatibility with the email package in Python 3.2. A ``policy`` can be
667specified when an email message is parsed by a :mod:`~email.parser`, or when a
668:class:`~email.message.Message` object is created, or when an email is
669serialized using a :mod:`~email.generator`. Unless overridden, a policy passed
670to a ``parser`` is inherited by all the ``Message`` object and sub-objects
671created by the ``parser``. By default a ``generator`` will use the policy of
672the ``Message`` object it is serializing. The default policy is
673:data:`~email.policy.compat32`.
674
675The minimum set of controls implemented by all ``policy`` objects are:
676
677 =============== =======================================================
678 max_line_length The maximum length, excluding the linesep character(s),
679 individual lines may have when a ``Message`` is
680 serialized. Defaults to 78.
681
682 linesep The character used to separate individual lines when a
683 ``Message`` is serialized. Defaults to ``\n``.
684
685 cte_type ``7bit`` or ``8bit``. ``8bit`` applies only to a
686 ``Bytes`` ``generator``, and means that non-ASCII may
687 be used where allowed by the protocol (or where it
688 exists in the original input).
689
690 raise_on_defect Causes a ``parser`` to raise error when defects are
691 encountered instead of adding them to the ``Message``
692 object's ``defects`` list.
693 =============== =======================================================
694
695A new policy instance, with new settings, is created using the
696:meth:`~email.policy.Policy.clone` method of policy objects. ``clone`` takes
697any of the above controls as keyword arguments. Any control not specified in
698the call retains its default value. Thus you can create a policy that uses
699``\r\n`` linesep characters like this::
700
Georg Brandl3539afd2012-05-30 22:03:20 +0200701 mypolicy = compat32.clone(linesep='\r\n')
R David Murray0fa2edd2012-05-25 17:59:56 -0400702
703Policies can be used to make the generation of messages in the format needed by
704your application simpler. Instead of having to remember to specify
705``linesep='\r\n'`` in all the places you call a ``generator``, you can specify
706it once, when you set the policy used by the ``parser`` or the ``Message``,
707whichever your program uses to create ``Message`` objects. On the other hand,
708if you need to generate messages in multiple forms, you can still specify the
709parameters in the appropriate ``generator`` call. Or you can have custom
710policy instances for your different cases, and pass those in when you create
711the ``generator``.
712
713
R David Murraycb448cf2012-05-25 22:25:56 -0400714Provisional Policy with New Header API
715--------------------------------------
716
717While the policy framework is worthwhile all by itself, the main motivation for
718introducing it is to allow the creation of new policies that implement new
719features for the email package in a way that maintains backward compatibility
720for those who do not use the new policies. Because the new policies introduce a
721new API, we are releasing them in Python 3.3 as a :term:`provisional policy
722<provisional package>`. Backwards incompatible changes (up to and including
723removal of the code) may occur if deemed necessary by the core developers.
724
725The new policies are instances of :class:`~email.policy.EmailPolicy`,
726and add the following additional controls:
727
728 =============== =======================================================
729 refold_source Controls whether or not headers parsed by a
730 :mod:`~email.parser` are refolded by the
731 :mod:`~email.generator`. It can be ``none``, ``long``,
732 or ``all``. The default is ``long``, which means that
733 source headers with a line longer than
734 ``max_line_length`` get refolded. ``none`` means no
735 line get refolded, and ``all`` means that all lines
736 get refolded.
737
738 header_factory A callable that take a ``name`` and ``value`` and
739 produces a custom header object.
740 =============== =======================================================
741
742The ``header_factory`` is the key to the new features provided by the new
743policies. When one of the new policies is used, any header retrieved from
744a ``Message`` object is an object produced by the ``header_factory``, and any
745time you set a header on a ``Message`` it becomes an object produced by
746``header_factory``. All such header objects have a ``name`` attribute equal
747to the header name. Address and Date headers have additional attributes
748that give you access to the parsed data of the header. This means you can now
749do things like this::
750
751 >>> m = Message(policy=SMTP)
752 >>> m['To'] = 'Éric <foo@example.com>'
753 >>> m['to']
754 'Éric <foo@example.com>'
755 >>> m['to'].addresses
756 (Address(display_name='Éric', username='foo', domain='example.com'),)
757 >>> m['to'].addresses[0].username
758 'foo'
759 >>> m['to'].addresses[0].display_name
760 'Éric'
761 >>> m['Date'] = email.utils.localtime()
762 >>> m['Date'].datetime
763 datetime.datetime(2012, 5, 25, 21, 39, 24, 465484, tzinfo=datetime.timezone(datetime.timedelta(-1, 72000), 'EDT'))
764 >>> m['Date']
765 'Fri, 25 May 2012 21:44:27 -0400'
766 >>> print(m)
767 To: =?utf-8?q?=C3=89ric?= <foo@example.com>
768 Date: Fri, 25 May 2012 21:44:27 -0400
769
770You will note that the unicode display name is automatically encoded as
771``utf-8`` when the message is serialized, but that when the header is accessed
772directly, you get the unicode version. This eliminates any need to deal with
773the :mod:`email.header` :meth:`~email.header.decode_header` or
774:meth:`~email.header.make_header` functions.
775
776You can also create addresses from parts::
777
778 >>> m['cc'] = [Group('pals', [Address('Bob', 'bob', 'example.com'),
779 ... Address('Sally', 'sally', 'example.com')]),
780 ... Address('Bonzo', addr_spec='bonz@laugh.com')]
781 >>> print(m)
782 To: =?utf-8?q?=C3=89ric?= <foo@example.com>
783 Date: Fri, 25 May 2012 21:44:27 -0400
784 cc: pals: Bob <bob@example.com>, Sally <sally@example.com>;, Bonzo <bonz@laugh.com>
785
786Decoding to unicode is done automatically::
787
788 >>> m2 = message_from_string(str(m))
789 >>> m2['to']
790 'Éric <foo@example.com>'
791
792When you parse a message, you can use the ``addresses`` and ``groups``
793attributes of the header objects to access the groups and individual
794addresses::
795
796 >>> m2['cc'].addresses
797 (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'))
798 >>> m2['cc'].groups
799 (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'),))
800
801In summary, if you use one of the new policies, header manipulation works the
802way it ought to: your application works with unicode strings, and the email
803package transparently encodes and decodes the unicode to and from the RFC
804standard Content Transfer Encodings.
805
806
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000807Other Language Changes
808======================
809
810Some smaller changes made to the core Python language are:
811
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100812* Added support for Unicode name aliases and named sequences.
813 Both :func:`unicodedata.lookup()` and ``'\N{...}'`` now resolve name aliases,
814 and :func:`unicodedata.lookup()` resolves named sequences too.
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000815
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100816 (Contributed by Ezio Melotti in :issue:`12753`)
Ezio Melotti931b8aa2011-10-21 21:57:36 +0300817
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100818* Equality comparisons on :func:`range` objects now return a result reflecting
819 the equality of the underlying sequences generated by those range objects.
Ezio Melotti931b8aa2011-10-21 21:57:36 +0300820
Sandro Tosicd899122012-01-22 12:16:04 +0100821 (:issue:`13201`)
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000822
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100823* The ``count()``, ``find()``, ``rfind()``, ``index()`` and ``rindex()``
824 methods of :class:`bytes` and :class:`bytearray` objects now accept an
825 integer between 0 and 255 as their first argument.
Mark Dickinson36645682011-10-23 19:53:01 +0100826
Petri Lehtinen6c3f1dd2012-06-26 10:23:07 +0300827 (Contributed by Petri Lehtinen in :issue:`12170`)
Mark Dickinson36645682011-10-23 19:53:01 +0100828
Eli Bendersky7add4ea2012-03-17 15:14:35 +0200829* New methods have been added to :class:`list` and :class:`bytearray`:
830 ``copy()`` and ``clear()``.
831
832 (:issue:`10516`)
Petri Lehtinen61ea8a02011-11-24 22:00:46 +0200833
Antoine Pitrou9a864472012-05-04 23:15:47 +0200834* Raw bytes literals can now be written ``rb"..."`` as well as ``br"..."``.
835 (Contributed by Antoine Pitrou in :issue:`13748`.)
836
837* :meth:`dict.setdefault` now does only one lookup for the given key, making
838 it atomic when used with built-in types.
839 (Contributed by Filip Gruszczyński in :issue:`13521`.)
840
841
Benjamin Petersone50d6ab2012-04-03 00:52:18 -0400842.. XXX mention new error messages for passing wrong number of arguments to functions
843
Antoine Pitrou9a864472012-05-04 23:15:47 +0200844
Antoine Pitrou79341e72012-05-17 21:13:45 +0200845A Finer-Grained Import Lock
846===========================
847
848Previous versions of CPython have always relied on a global import lock.
849This led to unexpected annoyances, such as deadlocks when importing a module
850would trigger code execution in a different thread as a side-effect.
851Clumsy workarounds were sometimes employed, such as the
852:c:func:`PyImport_ImportModuleNoBlock` C API function.
853
854In Python 3.3, importing a module takes a per-module lock. This correctly
855serializes importation of a given module from multiple threads (preventing
856the exposure of incompletely initialized modules), while eliminating the
857aforementioned annoyances.
858
859(contributed by Antoine Pitrou in :issue:`9260`.)
860
861
Victor Stinner8f17c1c2012-08-05 16:31:32 +0200862Builtin functions and types
863===========================
Victor Stinnerfa0d6282012-08-05 15:56:51 +0200864
Victor Stinner8f17c1c2012-08-05 16:31:32 +0200865* :func:`open` gets a new *opener* parameter: the underlying file descriptor
866 for the file object is then obtained by calling *opener* with (*file*,
867 *flags*). It can be used to use custom flags like :data:`os.O_CLOEXEC` for
868 example. The ``'x'`` mode was added: open for exclusive creation, failing if
869 the file already exists.
870* :func:`print`: added the *flush* keyword argument. If the *flush* keyword
871 argument is true, the stream is forcibly flushed.
872* :func:`hash`: hash randomization is enabled by default, see
873 :meth:`object.__hash__` and :envvar:`PYTHONHASHSEED`.
874* The :class:`str` type gets a new :meth:`~str.casefold` method: return a
875 casefolded copy of the string, casefolded strings may be used for caseless
876 matching. For example, ``'ß'.casefold()`` returns ``'ss'``.
Nick Coghlan273069c2012-08-20 17:14:07 +1000877* The sequence documentation has been substantially rewritten to better
878 explain the binary/text sequence distinction and to provide specific
879 documentation sections for the individual builtin sequence types
880 (:issue:`4966`)
Victor Stinnerfa0d6282012-08-05 15:56:51 +0200881
Victor Stinner636130e2012-08-05 16:37:12 +0200882New Modules
883===========
884
885faulthandler
886------------
887
888This new debug module contains functions to dump Python tracebacks explicitly,
889on a fault (a crash like a segmentation fault), after a timeout, or on a user
890signal. Call :func:`faulthandler.enable` to install fault handlers for the
891:const:`SIGSEGV`, :const:`SIGFPE`, :const:`SIGABRT`, :const:`SIGBUS`, and
892:const:`SIGILL` signals. You can also enable them at startup by setting the
893:envvar:`PYTHONFAULTHANDLER` environment variable or by using :option:`-X`
894``faulthandler`` command line option.
895
896Example of a segmentation fault on Linux: ::
897
898 $ python -q -X faulthandler
899 >>> import ctypes
900 >>> ctypes.string_at(0)
901 Fatal Python error: Segmentation fault
902
903 Current thread 0x00007fb899f39700:
904 File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at
905 File "<stdin>", line 1 in <module>
906 Segmentation fault
907
908
909ipaddress
910---------
911
912The new :mod:`ipaddress` module provides tools for creating and manipulating
913objects representing IPv4 and IPv6 addresses, networks and interfaces (i.e.
914an IP address associated with a specific IP subnet).
915
916(Contributed by Google and Peter Moody in :pep:`3144`)
917
918lzma
919----
920
921The newly-added :mod:`lzma` module provides data compression and decompression
922using the LZMA algorithm, including support for the ``.xz`` and ``.lzma``
923file formats.
924
925(Contributed by Nadeem Vawda and Per Øyvind Karlsen in :issue:`6715`)
926
927
928Improved Modules
929================
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000930
Victor Stinnerf4c54ff2012-02-08 01:48:34 +0100931abc
932---
933
934Improved support for abstract base classes containing descriptors composed with
935abstract methods. The recommended approach to declaring abstract descriptors is
936now to provide :attr:`__isabstractmethod__` as a dynamically updated
937property. The built-in descriptors have been updated accordingly.
938
939 * :class:`abc.abstractproperty` has been deprecated, use :class:`property`
940 with :func:`abc.abstractmethod` instead.
941 * :class:`abc.abstractclassmethod` has been deprecated, use
942 :class:`classmethod` with :func:`abc.abstractmethod` instead.
943 * :class:`abc.abstractstaticmethod` has been deprecated, use
944 :class:`staticmethod` with :func:`abc.abstractmethod` instead.
945
946(Contributed by Darren Dale in :issue:`11610`)
947
Meador Ingec5dbb3d2011-09-20 21:48:16 -0500948array
949-----
950
951The :mod:`array` module supports the :c:type:`long long` type using ``q`` and
952``Q`` type codes.
953
954(Contributed by Oren Tirosh and Hirokazu Yamamoto in :issue:`1172711`)
955
956
Victor Stinner8f17c1c2012-08-05 16:31:32 +0200957base64, binascii
958----------------
959
960ASCII-only Unicode strings are now accepted by the decoding functions of the
961modern interface. For example, ``base64.b64decode('YWJj')`` returns ``b'abc'``.
962
963
Nadeem Vawdad7e5c6e2012-02-12 01:34:18 +0200964bz2
965---
966
967The :mod:`bz2` module has been rewritten from scratch. In the process, several
968new features have been added:
969
Victor Stinner8f17c1c2012-08-05 16:31:32 +0200970* New :func:`bz2.open` function: open a bzip2-compressed file in binary or
971 text mode.
972
Nadeem Vawdad7e5c6e2012-02-12 01:34:18 +0200973* :class:`bz2.BZ2File` can now read from and write to arbitrary file-like
974 objects, by means of its constructor's *fileobj* argument.
975
976 (Contributed by Nadeem Vawda in :issue:`5863`)
977
978* :class:`bz2.BZ2File` and :func:`bz2.decompress` can now decompress
979 multi-stream inputs (such as those produced by the :program:`pbzip2` tool).
980 :class:`bz2.BZ2File` can now also be used to create this type of file, using
981 the ``'a'`` (append) mode.
982
983 (Contributed by Nir Aides in :issue:`1625`)
984
985* :class:`bz2.BZ2File` now implements all of the :class:`io.BufferedIOBase` API,
986 except for the :meth:`detach` and :meth:`truncate` methods.
987
988
Victor Stinner2cded9c2011-07-08 01:45:13 +0200989codecs
990------
991
Antoine Pitrou4f863432012-02-12 02:12:47 +0100992The :mod:`~encodings.mbcs` codec has been rewritten to handle correctly
Georg Brandlff962c52012-02-04 08:55:56 +0100993``replace`` and ``ignore`` error handlers on all Windows versions. The
994:mod:`~encodings.mbcs` codec now supports all error handlers, instead of only
995``replace`` to encode and ``ignore`` to decode.
Victor Stinner3a50e702011-10-18 21:21:00 +0200996
Georg Brandlff962c52012-02-04 08:55:56 +0100997A new Windows-only codec has been added: ``cp65001`` (:issue:`13216`). It is the
998Windows code page 65001 (Windows UTF-8, ``CP_UTF8``). For example, it is used
999by ``sys.stdout`` if the console output code page is set to cp65001 (e.g., using
1000``chcp 65001`` command).
Victor Stinner2f3ca9f2011-10-27 01:38:56 +02001001
Georg Brandlff962c52012-02-04 08:55:56 +01001002Multibyte CJK decoders now resynchronize faster. They only ignore the first
Georg Brandl6c0929b2011-07-09 11:43:33 +02001003byte of an invalid byte sequence. For example, ``b'\xff\n'.decode('gb2312',
1004'replace')`` now returns a ``\n`` after the replacement character.
Victor Stinner2cded9c2011-07-08 01:45:13 +02001005
Georg Brandl6c0929b2011-07-09 11:43:33 +02001006(:issue:`12016`)
Victor Stinner2cded9c2011-07-08 01:45:13 +02001007
Georg Brandlff962c52012-02-04 08:55:56 +01001008Incremental CJK codec encoders are no longer reset at each call to their
1009encode() methods. For example::
Victor Stinner2cded9c2011-07-08 01:45:13 +02001010
1011 $ ./python -q
1012 >>> import codecs
1013 >>> encoder = codecs.getincrementalencoder('hz')('strict')
1014 >>> b''.join(encoder.encode(x) for x in '\u52ff\u65bd\u65bc\u4eba\u3002 Bye.')
1015 b'~{NpJ)l6HK!#~} Bye.'
1016
Georg Brandl6c0929b2011-07-09 11:43:33 +02001017This example gives ``b'~{Np~}~{J)~}~{l6~}~{HK~}~{!#~} Bye.'`` with older Python
Victor Stinner2cded9c2011-07-08 01:45:13 +02001018versions.
1019
Georg Brandl6c0929b2011-07-09 11:43:33 +02001020(:issue:`12100`)
Victor Stinner2cded9c2011-07-08 01:45:13 +02001021
Victor Stinner9f4b1e92011-11-10 20:56:30 +01001022The ``unicode_internal`` codec has been deprecated.
1023
Éric Araujo4f61a2d2012-04-04 23:01:01 -04001024
1025collections
1026-----------
1027
1028Addition of a new :class:`~collections.ChainMap` class to allow treating a
1029number of mappings as a single unit.
1030
1031(Written by Raymond Hettinger for :issue:`11089`, made public in
1032:issue:`11297`)
1033
1034The abstract base classes have been moved in a new :mod:`collections.abc`
1035module, to better differentiate between the abstract and the concrete
1036collections classes. Aliases for ABCs are still present in the
1037:mod:`collections` module to preserve existing imports.
1038
1039(:issue:`11085`)
1040
1041.. XXX addition of __slots__ to ABCs not recorded here: internal detail
1042
1043
Nick Coghlan3267a302012-05-21 22:54:43 +10001044contextlib
1045----------
1046
1047:class:`~collections.ExitStack` now provides a solid foundation for
1048programmatic manipulation of context managers and similar cleanup
1049functionality. Unlike the previous ``contextlib.nested`` API (which was
1050deprecated and removed), the new API is designed to work correctly
1051regardless of whether context managers acquire their resources in
Nick Coghlan161ea6a2012-05-22 23:04:42 +10001052their ``__init__`` method (for example, file objects) or in their
Nick Coghlan3267a302012-05-21 22:54:43 +10001053``__enter__`` method (for example, synchronisation objects from the
1054:mod:`threading` module).
1055
1056(:issue:`13585`)
1057
1058
Éric Araujo84b8ed82011-08-29 21:42:47 +02001059crypt
1060-----
1061
Victor Stinner8f17c1c2012-08-05 16:31:32 +02001062Addition of salt and modular crypt format (hashing method) and the :func:`~crypt.mksalt`
Victor Stinnerc78fb332011-09-21 03:35:44 +02001063function to the :mod:`crypt` module.
Éric Araujo84b8ed82011-08-29 21:42:47 +02001064
1065(:issue:`10924`)
1066
Victor Stinnera7878b72011-07-14 23:07:44 +02001067curses
1068------
1069
Victor Stinner0fdfceb2011-11-25 22:10:02 +01001070 * If the :mod:`curses` module is linked to the ncursesw library, use Unicode
1071 functions when Unicode strings or characters are passed (e.g.
1072 :c:func:`waddwstr`), and bytes functions otherwise (e.g. :c:func:`waddstr`).
1073 * Use the locale encoding instead of ``utf-8`` to encode Unicode strings.
1074 * :class:`curses.window` has a new :attr:`curses.window.encoding` attribute.
Victor Stinnerc78fb332011-09-21 03:35:44 +02001075 * The :class:`curses.window` class has a new :meth:`~curses.window.get_wch`
1076 method to get a wide character
1077 * The :mod:`curses` module has a new :meth:`~curses.unget_wch` function to
1078 push a wide character so the next :meth:`~curses.window.get_wch` will return
1079 it
Victor Stinnera7878b72011-07-14 23:07:44 +02001080
Victor Stinnerc78fb332011-09-21 03:35:44 +02001081(Contributed by Iñigo Serna in :issue:`6755`)
Victor Stinnera7878b72011-07-14 23:07:44 +02001082
Victor Stinner8f17c1c2012-08-05 16:31:32 +02001083datetime
1084--------
1085
1086 * Equality comparisons between naive and aware :class:`~datetime.datetime`
1087 instances don't raise :exc:`TypeError`.
1088 * New :meth:`datetime.datetime.timestamp` method: Return POSIX timestamp
1089 corresponding to the :class:`~datetime.datetime` instance.
1090 * The :meth:`datetime.datetime.strftime` method supports formatting years
1091 older than 1000.
R David Murraydefdb162012-09-29 10:53:31 -04001092 * The :meth:`datetime.datetime.astimezone` method can now be
Alexander Belopolsky35d600c2012-08-22 23:14:29 -04001093 called without arguments to convert datetime instance to the system
1094 timezone.
Victor Stinner8f17c1c2012-08-05 16:31:32 +02001095
Stefan Krah1919b7e2012-03-21 18:25:23 +01001096decimal
1097-------
1098
1099:issue:`7652` - integrate fast native decimal arithmetic.
1100 C-module and libmpdec written by Stefan Krah.
1101
1102The new C version of the decimal module integrates the high speed libmpdec
Stefan Krahbf803082012-04-01 13:07:24 +02001103library for arbitrary precision correctly-rounded decimal floating point
1104arithmetic. libmpdec conforms to IBM's General Decimal Arithmetic Specification.
Stefan Krah1919b7e2012-03-21 18:25:23 +01001105
Stefan Krah0c0914e2012-04-09 20:31:15 +02001106Performance gains range from 10x for database applications to 100x for
Stefan Krahbf803082012-04-01 13:07:24 +02001107numerically intensive applications. These numbers are expected gains
1108for standard precisions used in decimal floating point arithmetic. Since
1109the precision is user configurable, the exact figures may vary. For example,
1110in integer bignum arithmetic the differences can be significantly higher.
1111
1112The following table is meant as an illustration. Benchmarks are available
Georg Brandl204e7892012-04-01 13:10:58 +02001113at http://www.bytereef.org/mpdecimal/quickstart.html.
Stefan Krah1919b7e2012-03-21 18:25:23 +01001114
1115 +---------+-------------+--------------+-------------+
1116 | | decimal.py | _decimal | speedup |
1117 +=========+=============+==============+=============+
Stefan Kraha3f4a162012-09-01 14:27:51 +02001118 | pi | 42.02s | 0.345s | 120x |
Stefan Krah1919b7e2012-03-21 18:25:23 +01001119 +---------+-------------+--------------+-------------+
1120 | telco | 172.19s | 5.68s | 30x |
1121 +---------+-------------+--------------+-------------+
1122 | psycopg | 3.57s | 0.29s | 12x |
1123 +---------+-------------+--------------+-------------+
1124
1125Features
1126~~~~~~~~
1127
1128* The :exc:`~decimal.FloatOperation` signal optionally enables stricter
1129 semantics for mixing floats and Decimals.
1130
1131* If Python is compiled without threads, the C version automatically
1132 disables the expensive thread local context machinery. In this case,
1133 the variable :data:`~decimal.HAVE_THREADS` is set to False.
1134
1135API changes
1136~~~~~~~~~~~
1137
1138* The C module has the following context limits, depending on the machine
1139 architecture:
1140
1141 +-------------------+---------------------+------------------------------+
1142 | | 32-bit | 64-bit |
1143 +===================+=====================+==============================+
1144 | :const:`MAX_PREC` | :const:`425000000` | :const:`999999999999999999` |
1145 +-------------------+---------------------+------------------------------+
1146 | :const:`MAX_EMAX` | :const:`425000000` | :const:`999999999999999999` |
1147 +-------------------+---------------------+------------------------------+
1148 | :const:`MIN_EMIN` | :const:`-425000000` | :const:`-999999999999999999` |
1149 +-------------------+---------------------+------------------------------+
1150
1151* In the context templates (:class:`~decimal.DefaultContext`,
1152 :class:`~decimal.BasicContext` and :class:`~decimal.ExtendedContext`)
1153 the magnitude of :attr:`~decimal.Context.Emax` and
1154 :attr:`~decimal.Context.Emin` has changed to :const:`999999`.
1155
1156* The :class:`~decimal.Decimal` constructor in decimal.py does not observe
1157 the context limits and converts values with arbitrary exponents or precision
1158 exactly. Since the C version has internal limits, the following scheme is
1159 used: If possible, values are converted exactly, otherwise
1160 :exc:`~decimal.InvalidOperation` is raised and the result is NaN. In the
1161 latter case it is always possible to use :meth:`~decimal.Context.create_decimal`
1162 in order to obtain a rounded or inexact value.
1163
1164
1165* The power function in decimal.py is always correctly-rounded. In the
1166 C version, it is defined in terms of the correctly-rounded
1167 :meth:`~decimal.Decimal.exp` and :meth:`~decimal.Decimal.ln` functions,
1168 but the final result is only "almost always correctly rounded".
1169
1170
1171* In the C version, the context dictionary containing the signals is a
1172 :class:`~collections.abc.MutableMapping`. For speed reasons,
1173 :attr:`~decimal.Context.flags` and :attr:`~decimal.Context.traps` always
1174 refer to the same :class:`~collections.abc.MutableMapping` that the context
1175 was initialized with. If a new signal dictionary is assigned,
1176 :attr:`~decimal.Context.flags` and :attr:`~decimal.Context.traps`
1177 are updated with the new values, but they do not reference the RHS
1178 dictionary.
1179
1180
1181* Pickling a :class:`~decimal.Context` produces a different output in order
1182 to have a common interchange format for the Python and C versions.
1183
1184
1185* The order of arguments in the :class:`~decimal.Context` constructor has been
1186 changed to match the order displayed by :func:`repr`.
1187
1188
Stefan Krahaf3f3a72012-08-30 12:33:55 +02001189* The ``watchexp`` parameter in the :meth:`~decimal.Decimal.quantize` method
1190 is deprecated.
1191
1192
Victor Stinner811db3b2011-09-21 03:20:03 +02001193ftplib
1194------
1195
1196The :class:`~ftplib.FTP_TLS` class now provides a new
1197:func:`~ftplib.FTP_TLS.ccc` function to revert control channel back to
Florent Xicluna6d57d212011-10-23 22:23:57 +02001198plaintext. This can be useful to take advantage of firewalls that know how to
Victor Stinner811db3b2011-09-21 03:20:03 +02001199handle NAT with non-secure FTP without opening fixed ports.
1200
1201(Contributed by Giampaolo Rodolà in :issue:`12139`)
1202
1203
Victor Stinner8f17c1c2012-08-05 16:31:32 +02001204gc
1205--
1206
1207It is now possible to register callbacks invoked by the garbage collector
Georg Brandla81b4812012-08-11 08:43:59 +02001208before and after collection using the new :data:`~gc.callbacks` list.
Victor Stinner8f17c1c2012-08-05 16:31:32 +02001209
1210
Christian Heimes31940372012-06-26 10:16:55 +02001211hmac
1212----
1213
1214A new :func:`~hmac.compare_digest` function has been added to prevent
1215side channel attacks on digests through timing analysis.
1216
1217(Contributed by Nick Coghlan and Christian Heimes in issue:`15061`)
1218
1219
Antoine Pitrou5a8bc6f2011-11-17 02:20:48 +01001220imaplib
1221-------
1222
1223The :class:`~imaplib.IMAP4_SSL` constructor now accepts an SSLContext
1224parameter to control parameters of the secure channel.
1225
1226(Contributed by Sijin Joseph in :issue:`8808`)
1227
1228
Nick Coghlan2f92e542012-06-23 19:39:55 +10001229inspect
1230-------
1231
1232A new :func:`~inspect.getclosurevars` function has been added. This function
1233reports the current binding of all names referenced from the function body and
1234where those names were resolved, making it easier to verify correct internal
1235state when testing code that relies on stateful closures.
1236
1237(Contributed by Meador Inge and Nick Coghlan in :issue:`13062`)
1238
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001239A new :func:`~inspect.getgeneratorlocals` function has been added. This
1240function reports the current binding of local variables in the generator's
1241stack frame, making it easier to verify correct internal state when testing
1242generators.
1243
1244(Contributed by Meador Inge in :issue:`15153`)
1245
Charles-François Natalidc3044c2012-01-09 22:40:02 +01001246io
1247--
1248
Charles-François Natalid612de12012-01-14 11:51:00 +01001249The :func:`~io.open` function has a new ``'x'`` mode that can be used to
1250exclusively create a new file, and raise a :exc:`FileExistsError` if the file
1251already exists. It is based on the C11 'x' mode to fopen().
Charles-François Natalidc3044c2012-01-09 22:40:02 +01001252
1253(Contributed by David Townshend in :issue:`12760`)
1254
Victor Stinner8f17c1c2012-08-05 16:31:32 +02001255The constructor of the :class:`~io.TextIOWrapper` class has a new
1256*write_through* optional argument. If *write_through* is ``True``, calls to
1257:meth:`~io.TextIOWrapper.write` are guaranteed not to be buffered: any data
1258written on the :class:`~io.TextIOWrapper` object is immediately handled to its
1259underlying binary buffer.
1260
Charles-François Natalidc3044c2012-01-09 22:40:02 +01001261
Victor Stinnerfa0e3d52011-05-09 01:01:09 +02001262math
1263----
1264
1265The :mod:`math` module has a new function:
1266
1267 * :func:`~math.log2`: return the base-2 logarithm of *x*
1268 (Written by Mark Dickinson in :issue:`11888`).
1269
1270
Antoine Pitrou9a864472012-05-04 23:15:47 +02001271multiprocessing
1272---------------
1273
1274The new :func:`multiprocessing.connection.wait` function allows to poll
1275multiple objects (such as connections, sockets and pipes) with a timeout.
1276(Contributed by Richard Oudkerk in :issue:`12328`.)
1277
1278:class:`multiprocessing.Connection` objects can now be transferred over
1279multiprocessing connections.
1280(Contributed by Richard Oudkerk in :issue:`4892`.)
1281
1282
Victor Stinnerfa0e3d52011-05-09 01:01:09 +02001283nntplib
1284-------
1285
1286The :class:`nntplib.NNTP` class now supports the context manager protocol to
1287unconditionally consume :exc:`socket.error` exceptions and to close the NNTP
1288connection when done::
1289
1290 >>> from nntplib import NNTP
Ezio Melotti3c14b4e2011-07-13 11:44:44 +03001291 >>> with NNTP('news.gmane.org') as n:
Victor Stinnerfa0e3d52011-05-09 01:01:09 +02001292 ... n.group('gmane.comp.python.committers')
1293 ...
Ezio Melotti04f648c2011-07-26 09:37:46 +03001294 ('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers')
Victor Stinnerfa0e3d52011-05-09 01:01:09 +02001295 >>>
1296
1297(Contributed by Giampaolo Rodolà in :issue:`9795`)
1298
1299
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001300os
1301--
1302
Charles-François Natalia003af12011-06-01 20:30:52 +02001303* The :mod:`os` module has a new :func:`~os.pipe2` function that makes it
1304 possible to create a pipe with :data:`~os.O_CLOEXEC` or
1305 :data:`~os.O_NONBLOCK` flags set atomically. This is especially useful to
1306 avoid race conditions in multi-threaded programs.
1307
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00001308* The :mod:`os` module has a new :func:`~os.sendfile` function which provides
1309 an efficent "zero-copy" way for copying data from one file (or socket)
1310 descriptor to another. The phrase "zero-copy" refers to the fact that all of
1311 the copying of data between the two descriptors is done entirely by the
1312 kernel, with no copying of data into userspace buffers. :func:`~os.sendfile`
1313 can be used to efficiently copy data from a file on disk to a network socket,
1314 e.g. for downloading a file.
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001315
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00001316 (Patch submitted by Ross Lagerwall and Giampaolo Rodolà in :issue:`10882`.)
1317
Victor Stinnerfa0d6282012-08-05 15:56:51 +02001318* To avoid race conditions like symlink attacks and issues with temporary
1319 files and directories, it is more reliable (and also faster) to manipulate
1320 file descriptors instead of file names. Python 3.3 enhances existing functions
Victor Stinner8f17c1c2012-08-05 16:31:32 +02001321 and introduces new functions to work on file descriptors (:issue:`4761`,
Larry Hastings94717972012-09-21 09:30:19 -07001322 :issue:`10755` and :issue:`14626`).
Victor Stinnerfa0d6282012-08-05 15:56:51 +02001323
1324 - The :mod:`os` module has a new :func:`~os.fwalk` function similar to
1325 :func:`~os.walk` except that it also yields file descriptors referring to the
1326 directories visited. This is especially useful to avoid symlink races.
1327
1328 - The following functions get new optional *dir_fd* (:ref:`paths relative to
1329 directory descriptors <dir_fd>`) and/or *follow_symlinks* (:ref:`not
1330 following symlinks <follow_symlinks>`):
1331 :func:`~os.access`, :func:`~os.chflags`, :func:`~os.chmod`, :func:`~os.chown`,
1332 :func:`~os.link`, :func:`~os.lstat`, :func:`~os.mkdir`, :func:`~os.mkfifo`,
1333 :func:`~os.mknod`, :func:`~os.open`, :func:`~os.readlink`, :func:`~os.remove`,
1334 :func:`~os.rename`, :func:`~os.replace`, :func:`~os.rmdir`, :func:`~os.stat`,
1335 :func:`~os.symlink`, :func:`~os.unlink`, :func:`~os.utime`.
1336
1337 - The following functions now support a file descriptor for their path argument:
1338 :func:`~os.chdir`, :func:`~os.chmod`, :func:`~os.chown`,
Victor Stinner8f17c1c2012-08-05 16:31:32 +02001339 :func:`~os.execve`, :func:`~os.listdir`, :func:`~os.pathconf`, :func:`~os.path.exists`,
Victor Stinnerfa0d6282012-08-05 15:56:51 +02001340 :func:`~os.stat`, :func:`~os.statvfs`, :func:`~os.utime`.
1341
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00001342* The :mod:`os` module has two new functions: :func:`~os.getpriority` and
1343 :func:`~os.setpriority`. They can be used to get or set process
1344 niceness/priority in a fashion similar to :func:`os.nice` but extended to all
1345 processes instead of just the current one.
1346
1347 (Patch submitted by Giampaolo Rodolà in :issue:`10784`.)
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001348
Antoine Pitrou9a864472012-05-04 23:15:47 +02001349* The new :func:`os.replace` function allows cross-platform renaming of a
1350 file with overwriting the destination. With :func:`os.rename`, an existing
1351 destination file is overwritten under POSIX, but raises an error under
1352 Windows.
1353 (Contributed by Antoine Pitrou in :issue:`8828`.)
1354
Larry Hastings94717972012-09-21 09:30:19 -07001355* The stat family of functions (:func:`~os.stat`, :func:`~os.fstat`,
1356 and :func:`~os.lstat`) now support reading a file's timestamps
1357 with nanosecond precision. Symmetrically, :func:`~os.utime`
1358 can now write file timestamps with nanosecond precision. (Contributed by
1359 Larry Hastings in :issue:`14127`.)
1360
Antoine Pitrou9a864472012-05-04 23:15:47 +02001361* The new :func:`os.get_terminal_size` function queries the size of the
Victor Stinnerfa0d6282012-08-05 15:56:51 +02001362 terminal attached to a file descriptor. See also
1363 :func:`shutil.get_terminal_size`.
Antoine Pitrou9a864472012-05-04 23:15:47 +02001364 (Contributed by Zbigniew Jędrzejewski-Szmek in :issue:`13609`.)
1365
Georg Brandldba3b5c2012-06-26 09:36:14 +02001366.. XXX sort out this mess after beta1
Victor Stinnere5064372011-10-14 00:08:29 +02001367
Victor Stinner8f17c1c2012-08-05 16:31:32 +02001368* New functions to support Linux extended attributes (:issue:`12720`):
Victor Stinnerfa0d6282012-08-05 15:56:51 +02001369 :func:`~os.getxattr`, :func:`~os.listxattr`, :func:`~os.removexattr`,
1370 :func:`~os.setxattr`.
Victor Stinnere5064372011-10-14 00:08:29 +02001371
Victor Stinnerfa0d6282012-08-05 15:56:51 +02001372* New interface to the scheduler. These functions
1373 control how a process is allocated CPU time by the operating system. New
1374 functions:
1375 :func:`~os.sched_get_priority_max`, :func:`~os.sched_get_priority_min`,
1376 :func:`~os.sched_getaffinity`, :func:`~os.sched_getparam`,
1377 :func:`~os.sched_getscheduler`, :func:`~os.sched_rr_get_interval`,
1378 :func:`~os.sched_setaffinity`, :func:`~os.sched_setparam`,
1379 :func:`~os.sched_setscheduler`, :func:`~os.sched_yield`,
Victor Stinnere5064372011-10-14 00:08:29 +02001380
Victor Stinnerfa0d6282012-08-05 15:56:51 +02001381* New functions to control the file system:
Victor Stinnere5064372011-10-14 00:08:29 +02001382
Victor Stinnerfa0d6282012-08-05 15:56:51 +02001383 * :func:`~os.posix_fadvise`: Announces an intention to access data in a
1384 specific pattern thus allowing the kernel to make optimizations.
1385 * :func:`~os.posix_fallocate`: Ensures that enough disk space is allocated
1386 for a file.
1387 * :func:`~os.sync`: Force write of everything to disk.
Victor Stinnere5064372011-10-14 00:08:29 +02001388
Victor Stinnerfa0d6282012-08-05 15:56:51 +02001389* Add some extra posix functions to the os module:
Victor Stinnere5064372011-10-14 00:08:29 +02001390
Victor Stinnerfa0d6282012-08-05 15:56:51 +02001391 * :func:`~os.lockf`: Apply, test or remove a POSIX lock on an open file descriptor.
1392 * :func:`~os.pread`: Read from a file descriptor at an offset, the file
1393 offset remains unchanged.
1394 * :func:`~os.pwrite`: Write to a file descriptor from an offset, leaving
1395 the file offset unchanged.
1396 * :func:`~os.readv`: Read from a file descriptor into a number of writable buffers.
1397 * :func:`~os.truncate`: Truncate the file corresponding to *path*, so that
1398 it is at most *length* bytes in size.
1399 * :func:`~os.waitid`: Wait for the completion of one or more child processes.
1400 * :func:`~os.writev`: Write the contents of *buffers* to a file descriptor,
1401 where *buffers* is an arbitrary sequence of buffers.
1402 * :func:`~os.getgrouplist` (:issue:`9344`): Return list of group ids that
1403 specified user belongs to.
Victor Stinnere5064372011-10-14 00:08:29 +02001404
Victor Stinnerfa0d6282012-08-05 15:56:51 +02001405* :func:`~os.times` and :func:`~os.uname`: Return type changed from a tuple to
1406 a tuple-like object with named attributes.
Victor Stinnere5064372011-10-14 00:08:29 +02001407
Giampaolo Rodolà424298a2011-03-03 18:34:06 +00001408
Georg Brandl4c7c3c52012-03-10 22:36:48 +01001409pdb
1410---
1411
1412* Tab-completion is now available not only for command names, but also their
1413 arguments. For example, for the ``break`` command, function and file names
1414 are completed. (Contributed by Georg Brandl in :issue:`14210`)
1415
1416
Antoine Pitrou9a864472012-05-04 23:15:47 +02001417pickle
1418------
1419
1420:class:`pickle.Pickler` objects now have an optional
1421:attr:`~pickle.Pickler.dispatch_table` attribute allowing to set per-pickler
1422reduction functions.
1423(Contributed by Richard Oudkerk in :issue:`14166`.)
1424
1425
Victor Stinner383c3fc2011-05-25 01:35:05 +02001426pydoc
1427-----
1428
Victor Stinner6daa33c2011-05-25 01:41:22 +02001429The Tk GUI and the :func:`~pydoc.serve` function have been removed from the
1430:mod:`pydoc` module: ``pydoc -g`` and :func:`~pydoc.serve` have been deprecated
1431in Python 3.2.
Victor Stinner383c3fc2011-05-25 01:35:05 +02001432
1433
Antoine Pitrouad09b5d2012-06-24 22:41:33 +02001434re
1435--
1436
1437:class:`str` regular expressions now support ``\u`` and ``\U`` escapes.
1438
1439(Contributed by Serhiy Storchaka in :issue:`3665`.)
1440
1441
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001442sched
1443-----
Victor Stinner754851f2011-04-19 23:58:51 +02001444
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001445* :meth:`~sched.scheduler.run` now accepts a *blocking* parameter which when
1446 set to False makes the method execute the scheduled events due to expire
1447 soonest (if any) and then return immediately.
1448 This is useful in case you want to use the :class:`~sched.scheduler` in
1449 non-blocking applications. (Contributed by Giampaolo Rodolà in :issue:`13449`)
Victor Stinner754851f2011-04-19 23:58:51 +02001450
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001451* :class:`~sched.scheduler` class can now be safely used in multi-threaded
1452 environments. (Contributed by Josiah Carlson and Giampaolo Rodolà in
1453 :issue:`8684`)
1454
1455* *timefunc* and *delayfunct* parameters of :class:`~sched.scheduler` class
1456 constructor are now optional and defaults to :func:`time.time` and
1457 :func:`time.sleep` respectively. (Contributed by Chris Clark in
1458 :issue:`13245`)
1459
1460* :meth:`~sched.scheduler.enter` and :meth:`~sched.scheduler.enterabs`
1461 *argument* parameter is now optional. (Contributed by Chris Clark in
1462 :issue:`13245`)
1463
1464* :meth:`~sched.scheduler.enter` and :meth:`~sched.scheduler.enterabs`
1465 now accept a *kwargs* parameter. (Contributed by Chris Clark in
1466 :issue:`13245`)
1467
1468
R David Murrayaae25832012-09-29 09:49:05 -04001469shlex
1470-----
1471
1472* The previously undocumented helper function ``quote`` from the
1473 :mod:`pipes` modules has been moved to the :mod:`shlex` module and
1474 documented. :func:`~shlex.quote` properly escapes all characters in a string
1475 that might be otherwise given special meaning by the shell.
1476
1477
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001478shutil
1479------
1480
1481* The :mod:`shutil` module has these new fuctions:
1482
1483 * :func:`~shutil.disk_usage`: provides total, used and free disk space
1484 statistics. (Contributed by Giampaolo Rodolà in :issue:`12442`)
1485 * :func:`~shutil.chown`: allows one to change user and/or group of the given
1486 path also specifying the user/group names and not only their numeric
1487 ids. (Contributed by Sandro Tosi in :issue:`12191`)
Victor Stinnera9293352011-04-30 15:21:58 +02001488
Larry Hastings94717972012-09-21 09:30:19 -07001489* :func:`~shutil.copy2` and :func:`~shutil.copystat` now preserve file
1490 timestamps with nanosecond precision on platforms that support it.
1491 They also preserve file "extended attributes" on Linux. (Contributed
1492 by Larry Hastings in :issue:`14127` and :issue:`15238`.)
1493
Antoine Pitrou9a864472012-05-04 23:15:47 +02001494* The new :func:`shutil.get_terminal_size` function returns the size of the
1495 terminal window the interpreter is attached to.
1496 (Contributed by Zbigniew Jędrzejewski-Szmek in :issue:`13609`.)
1497
1498* Several functions now take an optional ``symlinks`` argument: when that
1499 parameter is true, symlinks aren't dereferenced and the operation instead
1500 acts on the symlink itself (or creates one, if relevant).
1501 (Contributed by Hynek Schlawack in :issue:`12715`.)
1502
Nick Coghlan5b0eca12012-06-24 16:43:06 +10001503* :func:`~shutil.rmtree` is now resistant to symlink attacks on platforms
1504 which support the new ``dir_fd`` parameter in :func:`os.open` and
Georg Brandldba3b5c2012-06-26 09:36:14 +02001505 :func:`os.unlink`. (Contributed by Martin von Löwis and Hynek Schlawack
Nick Coghlan5b0eca12012-06-24 16:43:06 +10001506 in :issue:`4489`.)
1507
Antoine Pitrou9a864472012-05-04 23:15:47 +02001508
Victor Stinnera9293352011-04-30 15:21:58 +02001509signal
1510------
1511
Victor Stinnerfa0e3d52011-05-09 01:01:09 +02001512* The :mod:`signal` module has new functions:
Victor Stinnera9293352011-04-30 15:21:58 +02001513
Victor Stinnerb3e72192011-05-08 01:46:11 +02001514 * :func:`~signal.pthread_sigmask`: fetch and/or change the signal mask of the
1515 calling thread (Contributed by Jean-Paul Calderone in :issue:`8407`) ;
1516 * :func:`~signal.pthread_kill`: send a signal to a thread ;
1517 * :func:`~signal.sigpending`: examine pending functions ;
1518 * :func:`~signal.sigwait`: wait a signal.
Ross Lagerwallbc808222011-06-25 12:13:40 +02001519 * :func:`~signal.sigwaitinfo`: wait for a signal, returning detailed
1520 information about it.
1521 * :func:`~signal.sigtimedwait`: like :func:`~signal.sigwaitinfo` but with a
1522 timeout.
Victor Stinnera9293352011-04-30 15:21:58 +02001523
Victor Stinnerd49b1f12011-05-08 02:03:15 +02001524* The signal handler writes the signal number as a single byte instead of
1525 a nul byte into the wakeup file descriptor. So it is possible to wait more
1526 than one signal and know which signals were raised.
1527
Victor Stinner388196e2011-05-10 17:13:00 +02001528* :func:`signal.signal` and :func:`signal.siginterrupt` raise an OSError,
1529 instead of a RuntimeError: OSError has an errno attribute.
1530
R David Murray1764c802012-09-29 11:42:36 -04001531
1532smtpd
1533-----
1534
1535* The :mod:`smtpd` module now supports :rfc:`5321` (extended SMTP) and :rfc:`1870`
1536 (size extension). Per the standard, these extensions are enabled if and only
1537 if the client initiates the session with an ``EHLO`` command.
1538
1539 (Initial ``ELHO`` support by Alberto Trevino. Size extension by Juhana
1540 Jauhiainen. Substantial additional work on the patch contributed by Michele
1541 Orrù and Dan Boswell. :issue:`8739`)
1542
1543
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001544smtplib
1545-------
1546
R David Murray1764c802012-09-29 11:42:36 -04001547* The :class:`~smtplib.SMTP_SSL` constructor and the :meth:`~smtplib.SMTP.starttls`
1548 method now accept an SSLContext parameter to control parameters of the secure
1549 channel.
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001550
R David Murray1764c802012-09-29 11:42:36 -04001551 (Contributed by Kasun Herath in :issue:`8809`)
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001552
1553
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001554socket
1555------
1556
Charles-François Natali47413c12011-10-06 19:47:44 +02001557* The :class:`~socket.socket` class now exposes additional methods to process
1558 ancillary data when supported by the underlying platform:
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001559
Charles-François Natali47413c12011-10-06 19:47:44 +02001560 * :func:`~socket.socket.sendmsg`
1561 * :func:`~socket.socket.recvmsg`
1562 * :func:`~socket.socket.recvmsg_into`
Nick Coghlan96fe56a2011-08-22 11:55:57 +10001563
Charles-François Natali47413c12011-10-06 19:47:44 +02001564 (Contributed by David Watson in :issue:`6560`, based on an earlier patch by
1565 Heiko Wundram)
1566
1567* The :class:`~socket.socket` class now supports the PF_CAN protocol family
1568 (http://en.wikipedia.org/wiki/Socketcan), on Linux
1569 (http://lwn.net/Articles/253425).
1570
1571 (Contributed by Matthias Fuchs, updated by Tiago Gonçalves in :issue:`10141`)
1572
Charles-François Natali10b8cf42011-11-10 19:21:37 +01001573* The :class:`~socket.socket` class now supports the PF_RDS protocol family
1574 (http://en.wikipedia.org/wiki/Reliable_Datagram_Sockets and
1575 http://oss.oracle.com/projects/rds/).
Victor Stinner754851f2011-04-19 23:58:51 +02001576
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001577
Victor Stinner99c8b162011-05-24 12:05:19 +02001578ssl
1579---
1580
Antoine Pitrou2c0a9672011-11-17 02:09:13 +01001581* The :mod:`ssl` module has two new random generation functions:
Victor Stinner99c8b162011-05-24 12:05:19 +02001582
1583 * :func:`~ssl.RAND_bytes`: generate cryptographically strong
1584 pseudo-random bytes.
1585 * :func:`~ssl.RAND_pseudo_bytes`: generate pseudo-random bytes.
1586
Antoine Pitrou2c0a9672011-11-17 02:09:13 +01001587 (Contributed by Victor Stinner in :issue:`12049`)
1588
1589* The :mod:`ssl` module now exposes a finer-grained exception hierarchy
1590 in order to make it easier to inspect the various kinds of errors.
1591
1592 (Contributed by Antoine Pitrou in :issue:`11183`)
1593
1594* :meth:`~ssl.SSLContext.load_cert_chain` now accepts a *password* argument
1595 to be used if the private key is encrypted.
1596
1597 (Contributed by Adam Simpkins in :issue:`12803`)
1598
Antoine Pitrou73fc8142011-12-23 20:58:36 +01001599* Diffie-Hellman key exchange, both regular and Elliptic Curve-based, is
1600 now supported through the :meth:`~ssl.SSLContext.load_dh_params` and
1601 :meth:`~ssl.SSLContext.set_ecdh_curve` methods.
1602
1603 (Contributed by Antoine Pitrou in :issue:`13626` and :issue:`13627`)
1604
Antoine Pitrou2c0a9672011-11-17 02:09:13 +01001605* SSL sockets have a new :meth:`~ssl.SSLSocket.get_channel_binding` method
1606 allowing the implementation of certain authentication mechanisms such as
1607 SCRAM-SHA-1-PLUS.
1608
1609 (Contributed by Jacek Konieczny in :issue:`12551`)
1610
Antoine Pitrou73fc8142011-12-23 20:58:36 +01001611* You can query the SSL compression algorithm used by an SSL socket, thanks
1612 to its new :meth:`~ssl.SSLSocket.compression` method.
1613
1614 (Contributed by Antoine Pitrou in :issue:`13634`)
1615
Antoine Pitrou9a864472012-05-04 23:15:47 +02001616* Support has been added for the Next Procotol Negotiation extension using
1617 the :meth:`ssl.SSLContext.set_npn_protocols` method.
1618
1619 (Contributed by Colin Marc in :issue:`14204`)
1620
Antoine Pitrouad09b5d2012-06-24 22:41:33 +02001621* SSL errors can now be introspected more easily thanks to
1622 :attr:`~ssl.SSLError.library` and :attr:`~ssl.SSLError.reason` attributes.
1623
1624 (Contributed by Antoine Pitrou in :issue:`14837`)
1625
Giampaolo Rodola'ffa1d0b2012-05-15 15:30:25 +02001626stat
1627----
1628
1629- The undocumented tarfile.filemode function has been moved to
1630 :func:`stat.filemode`. It can be used to convert a file's mode to a string of
1631 the form '-rwxrwxrwx'.
1632
1633 (Contributed by Giampaolo Rodolà in :issue:`14807`)
Antoine Pitrou73fc8142011-12-23 20:58:36 +01001634
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001635sys
1636---
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02001637
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001638* The :mod:`sys` module has a new :data:`~sys.thread_info` :term:`struct
1639 sequence` holding informations about the thread implementation.
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02001640
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001641 (:issue:`11223`)
Giampaolo Rodola'096dcb12011-06-27 11:17:51 +02001642
Nick Coghlan4fae8cd2012-06-11 23:07:51 +10001643textwrap
1644--------
1645
1646* The :mod:`textwrap` module has a new :func:`~textwrap.indent` that makes
1647 it straightforward to add a common prefix to selected lines in a block
1648 of text.
1649
1650 (:issue:`13857`)
Antoine Pitrou5a8bc6f2011-11-17 02:20:48 +01001651
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001652time
1653----
Antoine Pitrou5a8bc6f2011-11-17 02:20:48 +01001654
Victor Stinnerec895392012-04-29 02:41:27 +02001655The :pep:`418` added new functions to the :mod:`time` module:
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001656
Victor Stinnerec895392012-04-29 02:41:27 +02001657* :func:`~time.get_clock_info`: Get information on a clock.
1658* :func:`~time.monotonic`: Monotonic clock (cannot go backward), not affected
1659 by system clock updates.
1660* :func:`~time.perf_counter`: Performance counter with the highest available
1661 resolution to measure a short duration.
1662* :func:`~time.process_time`: Sum of the system and user CPU time of the
1663 current process.
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001664
Victor Stinnerec895392012-04-29 02:41:27 +02001665Other new functions:
1666
1667* :func:`~time.clock_getres`, :func:`~time.clock_gettime` and
1668 :func:`~time.clock_settime` functions with ``CLOCK_xxx`` constants.
1669 (Contributed by Victor Stinner in :issue:`10278`)
Victor Stinnerf4c54ff2012-02-08 01:48:34 +01001670
Antoine Pitrou5a8bc6f2011-11-17 02:20:48 +01001671
Victor Stinner0db176f2012-04-16 00:16:30 +02001672types
1673-----
1674
1675Add a new :class:`types.MappingProxyType` class: Read-only proxy of a mapping.
1676(:issue:`14386`)
1677
1678
Nick Coghlan7fc570a2012-05-20 02:34:13 +10001679The new functions `types.new_class` and `types.prepare_class` provide support
1680for PEP 3115 compliant dynamic type creation. (:issue:`14588`)
1681
1682
Senthil Kumarande49d642011-10-16 23:54:44 +08001683urllib
1684------
1685
1686The :class:`~urllib.request.Request` class, now accepts a *method* argument
1687used by :meth:`~urllib.request.Request.get_method` to determine what HTTP method
Senthil Kumarana41c9422011-10-20 02:37:08 +08001688should be used. For example, this will send a ``'HEAD'`` request::
Senthil Kumarande49d642011-10-16 23:54:44 +08001689
1690 >>> urlopen(Request('http://www.python.org', method='HEAD'))
1691
1692(:issue:`1673007`)
Giampaolo Rodola'096dcb12011-06-27 11:17:51 +02001693
Giampaolo Rodola'be55d992011-11-22 13:33:34 +01001694
Éric Araujo4f61a2d2012-04-04 23:01:01 -04001695webbrowser
1696----------
1697
1698The :mod:`webbrowser` module supports more browsers: Google Chrome (named
1699:program:`chrome`, :program:`chromium`, :program:`chrome-browser` or
1700:program:`chromium-browser` depending on the version and operating system) as
1701well as the the generic launchers :program:`xdg-open` from the FreeDesktop.org
1702project and :program:`gvfs-open` which is the default URI handler for GNOME 3.
1703
1704(:issue:`13620` and :issue:`14493`)
1705
1706
Eli Benderskyefcaba02012-08-09 08:20:20 +03001707xml.etree.ElementTree
1708---------------------
1709
1710The :mod:`xml.etree.ElementTree` module now imports its C accelerator by
1711default; there is no longer a need to explicitly import
1712:mod:`xml.etree.cElementTree` (this module stays for backwards compatibility,
1713but is now deprecated). In addition, the ``iter`` family of methods of
1714:class:`~xml.etree.ElementTree.Element` has been optimized (rewritten in C).
1715The module's documentation has also been greatly improved with added examples
1716and a more detailed reference.
1717
1718
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001719Optimizations
1720=============
1721
1722Major performance enhancements have been added:
1723
Éric Araujo4f61a2d2012-04-04 23:01:01 -04001724* Thanks to :pep:`393`, some operations on Unicode strings have been optimized:
Victor Stinner46606ce2011-11-20 18:27:55 +01001725
1726 * the memory footprint is divided by 2 to 4 depending on the text
Victor Stinnera996f1e2011-11-21 13:14:43 +01001727 * encode an ASCII string to UTF-8 doesn't need to encode characters anymore,
1728 the UTF-8 representation is shared with the ASCII representation
Victor Stinner6099a032011-12-18 14:22:26 +01001729 * the UTF-8 encoder has been optimized
1730 * repeating a single ASCII letter and getting a substring of a ASCII strings
1731 is 4 times faster
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001732
Antoine Pitrou5d7e1d32012-06-24 22:38:23 +02001733* UTF-8 is now 2x to 4x faster. UTF-16 encoding is now up to 10x faster.
Antoine Pitrou5cec9d22012-05-17 17:37:02 +02001734
Antoine Pitrouc9092962012-06-15 22:22:18 +02001735 (contributed by Serhiy Storchaka, :issue:`14624`, :issue:`14738` and
1736 :issue:`15026`.)
Antoine Pitrou5cec9d22012-05-17 17:37:02 +02001737
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001738
1739Build and C API Changes
1740=======================
1741
1742Changes to Python's build process and to the C API include:
1743
Stefan Krah95b1ba62012-02-29 17:27:21 +01001744* New :pep:`3118` related function:
1745
1746 * :c:func:`PyMemoryView_FromMemory`
1747
Éric Araujo4f61a2d2012-04-04 23:01:01 -04001748* :pep:`393` added new Unicode types, macros and functions:
Victor Stinner46606ce2011-11-20 18:27:55 +01001749
Victor Stinnera996f1e2011-11-21 13:14:43 +01001750 * High-level API:
1751
1752 * :c:func:`PyUnicode_CopyCharacters`
1753 * :c:func:`PyUnicode_FindChar`
1754 * :c:func:`PyUnicode_GetLength`, :c:macro:`PyUnicode_GET_LENGTH`
1755 * :c:func:`PyUnicode_New`
1756 * :c:func:`PyUnicode_Substring`
1757 * :c:func:`PyUnicode_ReadChar`, :c:func:`PyUnicode_WriteChar`
1758
1759 * Low-level API:
1760
1761 * :c:type:`Py_UCS1`, :c:type:`Py_UCS2`, :c:type:`Py_UCS4` types
1762 * :c:type:`PyASCIIObject` and :c:type:`PyCompactUnicodeObject` structures
1763 * :c:macro:`PyUnicode_READY`
1764 * :c:func:`PyUnicode_FromKindAndData`
1765 * :c:func:`PyUnicode_AsUCS4`, :c:func:`PyUnicode_AsUCS4Copy`
1766 * :c:macro:`PyUnicode_DATA`, :c:macro:`PyUnicode_1BYTE_DATA`,
1767 :c:macro:`PyUnicode_2BYTE_DATA`, :c:macro:`PyUnicode_4BYTE_DATA`
1768 * :c:macro:`PyUnicode_KIND` with :c:type:`PyUnicode_Kind` enum:
1769 :c:data:`PyUnicode_WCHAR_KIND`, :c:data:`PyUnicode_1BYTE_KIND`,
1770 :c:data:`PyUnicode_2BYTE_KIND`, :c:data:`PyUnicode_4BYTE_KIND`
1771 * :c:macro:`PyUnicode_READ`, :c:macro:`PyUnicode_READ_CHAR`, :c:macro:`PyUnicode_WRITE`
1772 * :c:macro:`PyUnicode_MAX_CHAR_VALUE`
1773
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001774
1775
Victor Stinnerd1be8782011-12-09 00:10:41 +01001776Deprecated
1777==========
1778
Georg Brandl0cd25c92011-04-29 13:45:54 +02001779Unsupported Operating Systems
Victor Stinnerd1be8782011-12-09 00:10:41 +01001780-----------------------------
Victor Stinnerb90db4c2011-04-26 22:48:24 +02001781
Brian Curtin49a40cd2011-05-02 22:30:06 -05001782OS/2 and VMS are no longer supported due to the lack of a maintainer.
1783
1784Windows 2000 and Windows platforms which set ``COMSPEC`` to ``command.com``
1785are no longer supported due to maintenance burden.
Victor Stinnerb90db4c2011-04-26 22:48:24 +02001786
1787
Victor Stinner46606ce2011-11-20 18:27:55 +01001788Deprecated Python modules, functions and methods
Victor Stinnerd1be8782011-12-09 00:10:41 +01001789------------------------------------------------
Victor Stinner19bd0692011-11-16 00:18:57 +01001790
Victor Stinner19bd0692011-11-16 00:18:57 +01001791* The ``unicode_internal`` codec has been deprecated because of the
Sandro Tosicd899122012-01-22 12:16:04 +01001792 :pep:`393`, use UTF-8, UTF-16 (``utf-16-le`` or ``utf-16-be``), or UTF-32
1793 (``utf-32-le`` or ``utf-32-be``)
Victor Stinner19bd0692011-11-16 00:18:57 +01001794* :meth:`ftplib.FTP.nlst` and :meth:`ftplib.FTP.dir`: use
Victor Stinner46606ce2011-11-20 18:27:55 +01001795 :meth:`ftplib.FTP.mlsd`
Victor Stinner19bd0692011-11-16 00:18:57 +01001796* :func:`platform.popen`: use the :mod:`subprocess` module. Check especially
1797 the :ref:`subprocess-replacements` section.
1798* :issue:`13374`: The Windows bytes API has been deprecated in the :mod:`os`
Victor Stinner46606ce2011-11-20 18:27:55 +01001799 module. Use Unicode filenames, instead of bytes filenames, to not depend on
Victor Stinner19bd0692011-11-16 00:18:57 +01001800 the ANSI code page anymore and to support any filename.
Florent Xiclunaa72a98f2012-02-13 11:03:30 +01001801* :issue:`13988`: The :mod:`xml.etree.cElementTree` module is deprecated. The
1802 accelerator is used automatically whenever available.
Victor Stinner47620a62012-04-29 02:52:39 +02001803* The behaviour of :func:`time.clock` depends on the platform: use the new
1804 :func:`time.perf_counter` or :func:`time.process_time` function instead,
1805 depending on your requirements, to have a well defined behaviour.
Victor Stinnerfa0d6282012-08-05 15:56:51 +02001806* The :func:`os.stat_float_times` function is deprecated.
Victor Stinner8f17c1c2012-08-05 16:31:32 +02001807* :mod:`abc` module:
1808
1809 * :class:`abc.abstractproperty` has been deprecated, use :class:`property`
1810 with :func:`abc.abstractmethod` instead.
1811 * :class:`abc.abstractclassmethod` has been deprecated, use
1812 :class:`classmethod` with :func:`abc.abstractmethod` instead.
1813 * :class:`abc.abstractstaticmethod` has been deprecated, use
1814 :class:`staticmethod` with :func:`abc.abstractmethod` instead.
1815
Victor Stinner19bd0692011-11-16 00:18:57 +01001816
1817
Victor Stinner46606ce2011-11-20 18:27:55 +01001818Deprecated functions and types of the C API
Victor Stinnerd1be8782011-12-09 00:10:41 +01001819-------------------------------------------
Victor Stinner46606ce2011-11-20 18:27:55 +01001820
Éric Araujo4f61a2d2012-04-04 23:01:01 -04001821The :c:type:`Py_UNICODE` has been deprecated by :pep:`393` and will be
Victor Stinner46606ce2011-11-20 18:27:55 +01001822removed in Python 4. All functions using this type are deprecated:
1823
Victor Stinner46606ce2011-11-20 18:27:55 +01001824Unicode functions and methods using :c:type:`Py_UNICODE` and
1825:c:type:`Py_UNICODE*` types:
1826
1827 * :c:macro:`PyUnicode_FromUnicode`: use :c:func:`PyUnicode_FromWideChar` or
1828 :c:func:`PyUnicode_FromKindAndData`
1829 * :c:macro:`PyUnicode_AS_UNICODE`, :c:func:`PyUnicode_AsUnicode`,
1830 :c:func:`PyUnicode_AsUnicodeAndSize`: use :c:func:`PyUnicode_AsWideCharString`
1831 * :c:macro:`PyUnicode_AS_DATA`: use :c:macro:`PyUnicode_DATA` with
1832 :c:macro:`PyUnicode_READ` and :c:macro:`PyUnicode_WRITE`
1833 * :c:macro:`PyUnicode_GET_SIZE`, :c:func:`PyUnicode_GetSize`: use
1834 :c:macro:`PyUnicode_GET_LENGTH` or :c:func:`PyUnicode_GetLength`
1835 * :c:macro:`PyUnicode_GET_DATA_SIZE`: use
1836 ``PyUnicode_GET_LENGTH(str) * PyUnicode_KIND(str)`` (only work on ready
1837 strings)
Victor Stinnerbf6e5602011-12-12 01:53:47 +01001838 * :c:func:`PyUnicode_AsUnicodeCopy`: use :c:func:`PyUnicode_AsUCS4Copy` or
1839 :c:func:`PyUnicode_AsWideCharString`
Victor Stinnerab595942011-12-17 04:59:06 +01001840 * :c:func:`PyUnicode_GetMax`
1841
Victor Stinner46606ce2011-11-20 18:27:55 +01001842
Victor Stinnera996f1e2011-11-21 13:14:43 +01001843Functions and macros manipulating Py_UNICODE* strings:
1844
1845 * :c:macro:`Py_UNICODE_strlen`: use :c:func:`PyUnicode_GetLength` or
1846 :c:macro:`PyUnicode_GET_LENGTH`
1847 * :c:macro:`Py_UNICODE_strcat`: use :c:func:`PyUnicode_CopyCharacters` or
1848 :c:func:`PyUnicode_FromFormat`
1849 * :c:macro:`Py_UNICODE_strcpy`, :c:macro:`Py_UNICODE_strncpy`,
1850 :c:macro:`Py_UNICODE_COPY`: use :c:func:`PyUnicode_CopyCharacters` or
1851 :c:func:`PyUnicode_Substring`
1852 * :c:macro:`Py_UNICODE_strcmp`: use :c:func:`PyUnicode_Compare`
1853 * :c:macro:`Py_UNICODE_strncmp`: use :c:func:`PyUnicode_Tailmatch`
1854 * :c:macro:`Py_UNICODE_strchr`, :c:macro:`Py_UNICODE_strrchr`: use
1855 :c:func:`PyUnicode_FindChar`
Victor Stinner606e19d2012-01-04 03:59:16 +01001856 * :c:macro:`Py_UNICODE_FILL`: use :c:func:`PyUnicode_Fill`
Victor Stinnerab595942011-12-17 04:59:06 +01001857 * :c:macro:`Py_UNICODE_MATCH`
Victor Stinnera996f1e2011-11-21 13:14:43 +01001858
Victor Stinner46606ce2011-11-20 18:27:55 +01001859Encoders:
1860
1861 * :c:func:`PyUnicode_Encode`: use :c:func:`PyUnicode_AsEncodedObject`
1862 * :c:func:`PyUnicode_EncodeUTF7`
Victor Stinnera996f1e2011-11-21 13:14:43 +01001863 * :c:func:`PyUnicode_EncodeUTF8`: use :c:func:`PyUnicode_AsUTF8` or
1864 :c:func:`PyUnicode_AsUTF8String`
Victor Stinner46606ce2011-11-20 18:27:55 +01001865 * :c:func:`PyUnicode_EncodeUTF32`
1866 * :c:func:`PyUnicode_EncodeUTF16`
1867 * :c:func:`PyUnicode_EncodeUnicodeEscape:` use
1868 :c:func:`PyUnicode_AsUnicodeEscapeString`
1869 * :c:func:`PyUnicode_EncodeRawUnicodeEscape:` use
1870 :c:func:`PyUnicode_AsRawUnicodeEscapeString`
1871 * :c:func:`PyUnicode_EncodeLatin1`: use :c:func:`PyUnicode_AsLatin1String`
1872 * :c:func:`PyUnicode_EncodeASCII`: use :c:func:`PyUnicode_AsASCIIString`
1873 * :c:func:`PyUnicode_EncodeCharmap`
1874 * :c:func:`PyUnicode_TranslateCharmap`
1875 * :c:func:`PyUnicode_EncodeMBCS`: use :c:func:`PyUnicode_AsMBCSString` or
1876 :c:func:`PyUnicode_EncodeCodePage` (with ``CP_ACP`` code_page)
1877 * :c:func:`PyUnicode_EncodeDecimal`,
1878 :c:func:`PyUnicode_TransformDecimalToASCII`
1879
1880
Stefan Krah029780b2012-08-24 20:14:12 +02001881Deprecated features
1882-------------------
1883
1884The :mod:`array` module's ``'u'`` format code is now deprecated and will be
1885removed in Python 4 together with the rest of the (:c:type:`Py_UNICODE`) API.
1886
1887
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001888Porting to Python 3.3
1889=====================
1890
1891This section lists previously described changes and other bugfixes
Antoine Pitrou037ffbf2011-10-24 00:25:41 +02001892that may require changes to your code.
1893
Barry Warsawc1e721b2012-07-30 16:24:12 -04001894.. _portingpythoncode:
1895
Antoine Pitrou037ffbf2011-10-24 00:25:41 +02001896Porting Python code
1897-------------------
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001898
Victor Stinnerfa0d6282012-08-05 15:56:51 +02001899* Hash randomization is enabled by default. Set the :envvar:`PYTHONHASHSEED`
1900 environment variable to ``0`` to disable hash randomization. See also the
1901 :meth:`object.__hash__` method.
Georg Brandld6c43402012-03-07 08:55:52 +01001902
Victor Stinner19bd0692011-11-16 00:18:57 +01001903* :issue:`12326`: On Linux, sys.platform doesn't contain the major version
Victor Stinnerff3d9392011-08-20 23:39:26 +02001904 anymore. It is now always 'linux', instead of 'linux2' or 'linux3' depending
1905 on the Linux version used to build Python. Replace sys.platform == 'linux2'
1906 with sys.platform.startswith('linux'), or directly sys.platform == 'linux' if
1907 you don't need to support older Python versions.
Éric Araujoc09fca62011-03-23 02:06:24 +01001908
Victor Stinnerecc6e662012-03-14 00:39:29 +01001909* :issue:`13847`, :issue:`14180`: :mod:`time` and :mod:`datetime`:
1910 :exc:`OverflowError` is now raised instead of :exc:`ValueError` if a
1911 timestamp is out of range. :exc:`OSError` is now raised if C functions
1912 :c:func:`gmtime` or :c:func:`localtime` failed.
1913
Brett Cannonc2043482012-04-29 20:59:41 -04001914* The default finders used by import now utilize a cache of what is contained
1915 within a specific directory. If you create a Python source file or sourceless
1916 bytecode file, make sure to call :func:`importlib.invalidate_caches` to clear
1917 out the cache for the finders to notice the new file.
1918
1919* :exc:`ImportError` now uses the full name of the module that was attemped to
1920 be imported. Doctests that check ImportErrors' message will need to be
1921 updated to use the full name of the module instead of just the tail of the
1922 name.
1923
1924* The **index** argument to :func:`__import__` now defaults to 0 instead of -1
1925 and no longer support negative values. It was an oversight when :pep:`328` was
1926 implemented that the default value remained -1. If you need to continue to
1927 perform a relative import followed by an absolute import, then perform the
1928 relative import using an index of 1, followed by another import using an
1929 index of 0. It is preferred, though, that you use
1930 :func:`importlib.import_module` rather than call :func:`__import__` directly.
1931
1932* :func:`__import__` no longer allows one to use an index value other than 0
1933 for top-level modules. E.g. ``__import__('sys', level=1)`` is now an error.
1934
1935* Because :attr:`sys.meta_path` and :attr:`sys.path_hooks` now have finders on
1936 them by default, you will most likely want to use :meth:`list.insert` instead
1937 of :meth:`list.append` to add to those lists.
1938
1939* Because ``None`` is now inserted into :attr:`sys.path_importer_cache`, if you
1940 are clearing out entries in the dictionary of paths that do not have a
1941 finder, you will need to remove keys paired with values of ``None`` **and**
Brett Cannon903c27c2012-07-09 14:15:32 -04001942 :class:`imp.NullImporter` to be backwards-compatible. This will lead to extra
Brett Cannonc2043482012-04-29 20:59:41 -04001943 overhead on older versions of Python that re-insert ``None`` into
1944 :attr:`sys.path_importer_cache` where it repesents the use of implicit
1945 finders, but semantically it should not change anything.
1946
1947* :meth:`importlib.abc.SourceLoader.path_mtime` is now deprecated in favour of
1948 :meth:`importlib.abc.SourceLoader.path_stats` as bytecode files now store
1949 both the modification time and size of the source file the bytecode file was
1950 compiled from.
1951
Brett Cannon077ef452012-08-02 17:50:06 -04001952* :class:`importlib.abc.Finder` no longer specifies a `find_module()` abstract
1953 method that must be implemented. If you were relying on subclasses to
1954 implement that method, make sure to check for the method's existence first.
1955 You will probably want to check for `find_loader()` first, though, in the
1956 case of working with :term:`path entry finders <path entry finder>`.
1957
Nick Coghlan60610002012-07-15 22:39:39 +10001958* :mod:`pkgutil` has been converted to use :mod:`importlib` internally. This
1959 eliminates many edge cases where the old behaviour of the PEP 302 import
1960 emulation failed to match the behaviour of the real import system. The
1961 import emulation itself is still present, but is now deprecated. The
1962 :func:`pkgutil.iter_importers` and :func:`pkgutil.walk_packages` functions
1963 special case the standard import hooks so they are still supported even
1964 though they do not provide the non-standard ``iter_modules()`` method.
Brett Cannon903c27c2012-07-09 14:15:32 -04001965
Brett Cannonc2043482012-04-29 20:59:41 -04001966
Antoine Pitrou037ffbf2011-10-24 00:25:41 +02001967Porting C code
1968--------------
1969
Stefan Krah54c32032012-02-29 17:47:21 +01001970* In the course of changes to the buffer API the undocumented
1971 :c:member:`~Py_buffer.smalltable` member of the
1972 :c:type:`Py_buffer` structure has been removed and the
1973 layout of the :c:type:`PyMemoryViewObject` has changed.
1974
1975 All extensions relying on the relevant parts in ``memoryobject.h``
1976 or ``object.h`` must be rebuilt.
1977
Antoine Pitrou037ffbf2011-10-24 00:25:41 +02001978* Due to :ref:`PEP 393 <pep-393>`, the :c:type:`Py_UNICODE` type and all
1979 functions using this type are deprecated (but will stay available for
1980 at least five years). If you were using low-level Unicode APIs to
1981 construct and access unicode objects and you want to benefit of the
Éric Araujo4f61a2d2012-04-04 23:01:01 -04001982 memory footprint reduction provided by PEP 393, you have to convert
Antoine Pitrou037ffbf2011-10-24 00:25:41 +02001983 your code to the new :doc:`Unicode API <../c-api/unicode>`.
1984
1985 However, if you only have been using high-level functions such as
1986 :c:func:`PyUnicode_Concat()`, :c:func:`PyUnicode_Join` or
1987 :c:func:`PyUnicode_FromFormat()`, your code will automatically take
1988 advantage of the new unicode representations.
1989
Brett Cannon77b2abd2012-07-09 16:09:00 -04001990* :c:func:`PyImport_GetMagicNumber` now returns -1 upon failure.
1991
Brett Cannon522267e2012-08-10 18:55:08 -04001992* As a negative value for the **level** argument to :func:`__import__` is no
1993 longer valid, the same now holds for :c:func:`PyImport_ImportModuleLevel`.
1994 This also means that the value of **level** used by
1995 :c:func:`PyImport_ImportModuleEx` is now 0 instead of -1.
1996
Brett Cannon77b2abd2012-07-09 16:09:00 -04001997
Antoine Pitrouc229e6e2012-02-20 19:41:11 +01001998Building C extensions
1999---------------------
2000
2001* The range of possible file names for C extensions has been narrowed.
2002 Very rarely used spellings have been suppressed: under POSIX, files
2003 named ``xxxmodule.so``, ``xxxmodule.abi3.so`` and
2004 ``xxxmodule.cpython-*.so`` are no longer recognized as implementing
2005 the ``xxx`` module. If you had been generating such files, you have
2006 to switch to the other spellings (i.e., remove the ``module`` string
2007 from the file names).
2008
2009 (implemented in :issue:`14040`.)
2010
2011
R David Murray1764c802012-09-29 11:42:36 -04002012Command Line Switch Changes
2013---------------------------
Antoine Pitrou037ffbf2011-10-24 00:25:41 +02002014
R David Murray1764c802012-09-29 11:42:36 -04002015* The -Q command-line flag and related artifacts have been removed. Code
2016 checking sys.flags.division_warning will need updating.
Éric Araujobe3bd572011-03-26 01:55:15 +01002017
R David Murray1764c802012-09-29 11:42:36 -04002018 (:issue:`10998`, contributed by Éric Araujo.)
2019
2020* When :program:`python` is started with :option:`-S`, ``import site``
2021 will no longer add site-specific paths to the module search paths. In
2022 previous versions, it did.
2023
2024 (:issue:`11591`, contributed by Carl Meyer with editions by Éric Araujo.)