blob: 18fb2e07ed77a2711ffb0a64e73d85d86d0b4324 [file] [log] [blame]
Ned Deily07a18922018-01-31 18:12:38 -05001****************************
2 What's New In Python 3.8
3****************************
4
Ned Deily07a18922018-01-31 18:12:38 -05005.. Rules for maintenance:
6
7 * Anyone can add text to this document. Do not spend very much time
8 on the wording of your changes, because your text will probably
9 get rewritten to some degree.
10
11 * The maintainer will go through Misc/NEWS periodically and add
12 changes; it's therefore more important to add your changes to
13 Misc/NEWS than to this file.
14
15 * This is not a complete list of every single change; completeness
16 is the purpose of Misc/NEWS. Some changes I consider too small
17 or esoteric to include. If such a change is added to the text,
18 I'll just remove it. (This is another reason you shouldn't spend
19 too much time on writing your addition.)
20
21 * If you want to draw your new text to the attention of the
22 maintainer, add 'XXX' to the beginning of the paragraph or
23 section.
24
25 * It's OK to just add a fragmentary note about a change. For
26 example: "XXX Describe the transmogrify() function added to the
27 socket module." The maintainer will research the change and
28 write the necessary text.
29
30 * You can comment out your additions if you like, but it's not
31 necessary (especially when a final release is some months away).
32
33 * Credit the author of a patch or bugfix. Just the name is
34 sufficient; the e-mail address isn't necessary.
35
36 * It's helpful to add the bug/patch number as a comment:
37
38 XXX Describe the transmogrify() function added to the socket
39 module.
40 (Contributed by P.Y. Developer in :issue:`12345`.)
41
Raymond Hettinger66a34d32019-08-12 15:55:18 -070042 This saves the maintainer the effort of going through the Git log
Ned Deily07a18922018-01-31 18:12:38 -050043 when researching a change.
44
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070045:Editor: Raymond Hettinger
Ned Deily07a18922018-01-31 18:12:38 -050046
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070047This article explains the new features in Python 3.8, compared to 3.7.
Ned Deily45ab51c2018-02-28 13:58:38 -050048For full details, see the :ref:`changelog <changelog>`.
Ned Deily07a18922018-01-31 18:12:38 -050049
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070050.. testsetup::
Nick Coghlanb9438ce2019-06-09 19:07:42 +100051
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070052 from datetime import date
53 from math import cos, radians
Raymond Hettinger66a34d32019-08-12 15:55:18 -070054 from unicodedata import normalize
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070055 import re
56 import math
Nick Coghlanb9438ce2019-06-09 19:07:42 +100057
Ned Deily07a18922018-01-31 18:12:38 -050058
59Summary -- Release highlights
60=============================
61
62.. This section singles out the most important changes in Python 3.8.
63 Brevity is key.
64
65
66.. PEP-sized items next.
67
68
69
70New Features
71============
72
Guido van Rossum09d434c2019-04-24 11:30:17 -070073Assignment expressions
74----------------------
75
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070076There is new syntax ``:=`` that assigns values to variables as part of a larger
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -040077expression. It is affectionately known as "the walrus operator" due to
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070078its resemblance to `the eyes and tusks of a walrus
79<https://en.wikipedia.org/wiki/Walrus#/media/File:Pacific_Walrus_-_Bull_(8247646168).jpg>`_.
80
81In this example, the assignment expression helps avoid calling
82:func:`len` twice::
Guido van Rossum09d434c2019-04-24 11:30:17 -070083
84 if (n := len(a)) > 10:
85 print(f"List is too long ({n} elements, expected <= 10)")
86
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070087A similar benefit arises during regular expression matching where
88match objects are needed twice, once to test whether a match
89occurred and another to extract a subgroup::
90
91 discount = 0.0
92 if (mo := re.search(r'(\d+)% discount', advertisement)):
93 discount = float(mo.group(1)) / 100.0
94
95The operator is also useful with while-loops that compute
96a value to test loop termination and then need that same
97value again in the body of the loop::
98
99 # Loop over fixed length blocks
100 while (block := f.read(256)) != '':
101 process(block)
102
103Another motivating use case arises in list comprehensions where
104a value computed in a filtering condition is also needed in
105the expression body::
106
107 [clean_name.title() for name in names
108 if (clean_name := normalize('NFC', name)) in allowed_names]
109
110Try to limit use of the walrus operator to clean cases that reduce
111complexity and improve readability.
112
Guido van Rossum09d434c2019-04-24 11:30:17 -0700113See :pep:`572` for a full description.
114
115(Contributed by Emily Morehouse in :issue:`35224`.)
116
Guido van Rossum09d434c2019-04-24 11:30:17 -0700117
Guido van Rossum843bf422019-04-29 05:49:30 -0700118Positional-only parameters
119--------------------------
120
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700121There is a new function parameter syntax ``/`` to indicate that some
122function parameters must be specified positionally and cannot be used as
123keyword arguments. This is the same notation shown by ``help()`` for C
124functions annotated with Larry Hastings' `Argument Clinic
125<https://docs.python.org/3/howto/clinic.html>`_ tool.
126
127In the following example, parameters *a* and *b* are positional-only,
128while *c* or *d* can be positional or keyword, and *e* or *f* are
129required to be keywords::
130
131 def f(a, b, /, c, d, *, e, f):
132 print(a, b, c, d, e, f)
133
134The following is a valid call::
135
136 f(10, 20, 30, d=40, e=50, f=60)
137
138However, these are invalid calls::
139
140 f(10, b=20, c=30, d=40, e=50, f=60) # b cannot be a keyword argument
141 f(10, 20, 30, 40, 50, f=60) # e must be a keyword argument
142
143One use case for this notation is that it allows pure Python functions
144to fully emulate behaviors of existing C coded functions. For example,
Ammar Askar5a58c522020-03-27 09:37:43 -0700145the built-in :func:`divmod` function does not accept keyword arguments::
Guido van Rossum843bf422019-04-29 05:49:30 -0700146
Ammar Askar5a58c522020-03-27 09:37:43 -0700147 def divmod(a, b, /):
148 "Emulate the built in divmod() function"
149 return (a // b, a % b)
Guido van Rossum843bf422019-04-29 05:49:30 -0700150
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700151Another use case is to preclude keyword arguments when the parameter
152name is not helpful. For example, the builtin :func:`len` function has
153the signature ``len(obj, /)``. This precludes awkward calls such as::
154
155 len(obj='hello') # The "obj" keyword argument impairs readability
156
157A further benefit of marking a parameter as positional-only is that it
158allows the parameter name to be changed in the future without risk of
159breaking client code. For example, in the :mod:`statistics` module, the
160parameter name *dist* may be changed in the future. This was made
161possible with the following function specification::
162
163 def quantiles(dist, /, *, n=4, method='exclusive')
164 ...
165
166Since the parameters to the left of ``/`` are not exposed as possible
167keywords, the parameters names remain available for use in ``**kwargs``::
168
169 >>> def f(a, b, /, **kwargs):
170 ... print(a, b, kwargs)
171 ...
172 >>> f(10, 20, a=1, b=2, c=3) # a and b are used in two ways
173 10 20 {'a': 1, 'b': 2, 'c': 3}
174
175This greatly simplifies the implementation of functions and methods
176that need to accept arbitrary keyword arguments. For example, here
Hugo van Kemenade547c60c2019-10-12 20:53:36 +0300177is an excerpt from code in the :mod:`collections` module::
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700178
179 class Counter(dict):
180
181 def __init__(self, iterable=None, /, **kwds):
182 # Note "iterable" is a possible keyword argument
Guido van Rossum843bf422019-04-29 05:49:30 -0700183
184See :pep:`570` for a full description.
185
186(Contributed by Pablo Galindo in :issue:`36540`.)
187
188.. TODO: Pablo will sprint on docs at PyCon US 2019.
189
190
Nick Coghlan16eb3bc2018-06-20 21:25:01 +1000191Parallel filesystem cache for compiled bytecode files
192-----------------------------------------------------
193
194The new :envvar:`PYTHONPYCACHEPREFIX` setting (also available as
195:option:`-X` ``pycache_prefix``) configures the implicit bytecode
196cache to use a separate parallel filesystem tree, rather than
197the default ``__pycache__`` subdirectories within each source
198directory.
199
200The location of the cache is reported in :data:`sys.pycache_prefix`
201(:const:`None` indicates the default location in ``__pycache__``
202subdirectories).
203
204(Contributed by Carl Meyer in :issue:`33499`.)
Ned Deily07a18922018-01-31 18:12:38 -0500205
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300206
Victor Stinner40460692019-04-26 17:56:44 +0200207Debug build uses the same ABI as release build
208-----------------------------------------------
209
Hugo van Kemenade547c60c2019-10-12 20:53:36 +0300210Python now uses the same ABI whether it's built in release or debug mode. On
Paul Ganssle5c403b22019-04-27 14:14:35 -0400211Unix, when Python is built in debug mode, it is now possible to load C
212extensions built in release mode and C extensions built using the stable ABI.
Victor Stinner40460692019-04-26 17:56:44 +0200213
Paul Ganssle5c403b22019-04-27 14:14:35 -0400214Release builds and debug builds are now ABI compatible: defining the
215``Py_DEBUG`` macro no longer implies the ``Py_TRACE_REFS`` macro, which
216introduces the only ABI incompatibility. The ``Py_TRACE_REFS`` macro, which
217adds the :func:`sys.getobjects` function and the :envvar:`PYTHONDUMPREFS`
218environment variable, can be set using the new ``./configure --with-trace-refs``
219build option.
Victor Stinner40460692019-04-26 17:56:44 +0200220(Contributed by Victor Stinner in :issue:`36465`.)
221
E. M. Brayc994c8f2019-05-24 17:33:47 +0200222On Unix, C extensions are no longer linked to libpython except on Android
223and Cygwin.
Victor Stinner4ebcd7e2019-05-11 04:10:03 +0200224It is now possible
Paul Ganssle5c403b22019-04-27 14:14:35 -0400225for a statically linked Python to load a C extension built using a shared
226library Python.
Victor Stinner40460692019-04-26 17:56:44 +0200227(Contributed by Victor Stinner in :issue:`21536`.)
228
229On Unix, when Python is built in debug mode, import now also looks for C
230extensions compiled in release mode and for C extensions compiled with the
231stable ABI.
232(Contributed by Victor Stinner in :issue:`36722`.)
233
Victor Stinner0a8e5722019-05-23 03:30:23 +0200234To embed Python into an application, a new ``--embed`` option must be passed to
235``python3-config --libs --embed`` to get ``-lpython3.8`` (link the application
236to libpython). To support both 3.8 and older, try ``python3-config --libs
237--embed`` first and fallback to ``python3-config --libs`` (without ``--embed``)
238if the previous command fails.
239
240Add a pkg-config ``python-3.8-embed`` module to embed Python into an
241application: ``pkg-config python-3.8-embed --libs`` includes ``-lpython3.8``.
242To support both 3.8 and older, try ``pkg-config python-X.Y-embed --libs`` first
243and fallback to ``pkg-config python-X.Y --libs`` (without ``--embed``) if the
244previous command fails (replace ``X.Y`` with the Python version).
245
246On the other hand, ``pkg-config python3.8 --libs`` no longer contains
247``-lpython3.8``. C extensions must not be linked to libpython (except on
E. M. Brayc994c8f2019-05-24 17:33:47 +0200248Android and Cygwin, whose cases are handled by the script);
249this change is backward incompatible on purpose.
Victor Stinner0a8e5722019-05-23 03:30:23 +0200250(Contributed by Victor Stinner in :issue:`36721`.)
251
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400252
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700253f-strings support ``=`` for self-documenting expressions and debugging
254----------------------------------------------------------------------
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400255
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700256Added an ``=`` specifier to :term:`f-string`\s. An f-string such as
257``f'{expr=}'`` will expand to the text of the expression, an equal sign,
258then the representation of the evaluated expression. For example:
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400259
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700260 >>> user = 'eric_idle'
261 >>> member_since = date(1975, 7, 31)
262 >>> f'{user=} {member_since=}'
263 "user='eric_idle' member_since=datetime.date(1975, 7, 31)"
264
265The usual :ref:`f-string format specifiers <f-strings>` allow more
266control over how the result of the expression is displayed::
267
268 >>> delta = date.today() - member_since
269 >>> f'{user=!s} {delta.days=:,d}'
270 'user=eric_idle delta.days=16,075'
271
272The ``=`` specifier will display the whole expression so that
273calculations can be shown::
274
275 >>> print(f'{theta=} {cos(radians(theta))=:.3f}')
276 theta=30 cos(radians(theta))=0.866
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400277
278(Contributed by Eric V. Smith and Larry Hastings in :issue:`36817`.)
279
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300280
Raymond Hettinger274bd012019-10-14 09:01:05 -0700281PEP 578: Python Runtime Audit Hooks
282-----------------------------------
283
284The PEP adds an Audit Hook and Verified Open Hook. Both are available from
285Python and native code, allowing applications and frameworks written in pure
286Python code to take advantage of extra notifications, while also allowing
287embedders or system administrators to deploy builds of Python where auditing is
288always enabled.
289
290See :pep:`578` for full details.
291
292
Victor Stinner331a6a52019-05-27 16:39:22 +0200293PEP 587: Python Initialization Configuration
294--------------------------------------------
295
296The :pep:`587` adds a new C API to configure the Python Initialization
297providing finer control on the whole configuration and better error reporting.
298
299New structures:
300
301* :c:type:`PyConfig`
302* :c:type:`PyPreConfig`
303* :c:type:`PyStatus`
304* :c:type:`PyWideStringList`
305
306New functions:
307
308* :c:func:`PyConfig_Clear`
309* :c:func:`PyConfig_InitIsolatedConfig`
310* :c:func:`PyConfig_InitPythonConfig`
311* :c:func:`PyConfig_Read`
312* :c:func:`PyConfig_SetArgv`
313* :c:func:`PyConfig_SetBytesArgv`
314* :c:func:`PyConfig_SetBytesString`
315* :c:func:`PyConfig_SetString`
316* :c:func:`PyPreConfig_InitIsolatedConfig`
317* :c:func:`PyPreConfig_InitPythonConfig`
318* :c:func:`PyStatus_Error`
319* :c:func:`PyStatus_Exception`
320* :c:func:`PyStatus_Exit`
321* :c:func:`PyStatus_IsError`
322* :c:func:`PyStatus_IsExit`
323* :c:func:`PyStatus_NoMemory`
324* :c:func:`PyStatus_Ok`
325* :c:func:`PyWideStringList_Append`
326* :c:func:`PyWideStringList_Insert`
327* :c:func:`Py_BytesMain`
328* :c:func:`Py_ExitStatusException`
329* :c:func:`Py_InitializeFromConfig`
330* :c:func:`Py_PreInitialize`
331* :c:func:`Py_PreInitializeFromArgs`
332* :c:func:`Py_PreInitializeFromBytesArgs`
333* :c:func:`Py_RunMain`
334
335This PEP also adds ``_PyRuntimeState.preconfig`` (:c:type:`PyPreConfig` type)
336and ``PyInterpreterState.config`` (:c:type:`PyConfig` type) fields to these
337internal structures. ``PyInterpreterState.config`` becomes the new
338reference configuration, replacing global configuration variables and
339other private variables.
340
341See :ref:`Python Initialization Configuration <init-config>` for the
342documentation.
343
344See :pep:`587` for a full description.
345
346(Contributed by Victor Stinner in :issue:`36763`.)
347
Ned Deily07a18922018-01-31 18:12:38 -0500348
Jeroen Demeyer9a13a382019-11-12 14:08:00 +0100349PEP 590: Vectorcall: a fast calling protocol for CPython
350--------------------------------------------------------
Jeroen Demeyer9e3e06e2019-06-03 01:43:13 +0200351
Jeroen Demeyer9a13a382019-11-12 14:08:00 +0100352:ref:`vectorcall` is added to the Python/C API.
Jeroen Demeyer9e3e06e2019-06-03 01:43:13 +0200353It is meant to formalize existing optimizations which were already done
354for various classes.
Jeroen Demeyer9a13a382019-11-12 14:08:00 +0100355Any static type implementing a callable can use this protocol.
Jeroen Demeyer9e3e06e2019-06-03 01:43:13 +0200356
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700357This is currently provisional.
358The aim is to make it fully public in Python 3.9.
Jeroen Demeyer9e3e06e2019-06-03 01:43:13 +0200359
360See :pep:`590` for a full description.
361
Jeroen Demeyer9a13a382019-11-12 14:08:00 +0100362(Contributed by Jeroen Demeyer, Mark Shannon and Petr Viktorin in :issue:`36974`.)
Jeroen Demeyer9e3e06e2019-06-03 01:43:13 +0200363
364
Antoine Pitrouc879ff22019-06-09 14:47:15 +0200365Pickle protocol 5 with out-of-band data buffers
366-----------------------------------------------
367
368When :mod:`pickle` is used to transfer large data between Python processes
369in order to take advantage of multi-core or multi-machine processing,
370it is important to optimize the transfer by reducing memory copies, and
371possibly by applying custom techniques such as data-dependent compression.
372
373The :mod:`pickle` protocol 5 introduces support for out-of-band buffers
374where :pep:`3118`-compatible data can be transmitted separately from the
375main pickle stream, at the discretion of the communication layer.
376
377See :pep:`574` for a full description.
378
379(Contributed by Antoine Pitrou in :issue:`36785`.)
380
381
Ned Deily07a18922018-01-31 18:12:38 -0500382Other Language Changes
383======================
384
Serhiy Storchakafe2bbb12018-03-18 09:56:52 +0200385* A :keyword:`continue` statement was illegal in the :keyword:`finally` clause
386 due to a problem with the implementation. In Python 3.8 this restriction
387 was lifted.
388 (Contributed by Serhiy Storchaka in :issue:`32489`.)
389
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700390* The :class:`bool`, :class:`int`, and :class:`fractions.Fraction` types
391 now have an :meth:`~int.as_integer_ratio` method like that found in
392 :class:`float` and :class:`decimal.Decimal`. This minor API extension
393 makes it possible to write ``numerator, denominator =
394 x.as_integer_ratio()`` and have it work across multiple numeric types.
395 (Contributed by Lisa Roach in :issue:`33073` and Raymond Hettinger in
396 :issue:`37819`.)
Lisa Roach5ac70432018-09-13 23:56:23 -0700397
Serhiy Storchakabdbad712019-06-02 00:05:48 +0300398* Constructors of :class:`int`, :class:`float` and :class:`complex` will now
399 use the :meth:`~object.__index__` special method, if available and the
400 corresponding method :meth:`~object.__int__`, :meth:`~object.__float__`
401 or :meth:`~object.__complex__` is not available.
402 (Contributed by Serhiy Storchaka in :issue:`20092`.)
403
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700404* Added support of ``\N{name}`` escapes in :mod:`regular expressions <re>`::
405
406 >>> notice = 'Copyright © 2019'
407 >>> copyright_year_pattern = re.compile(r'\N{copyright sign}\s*(\d{4})')
408 >>> int(copyright_year_pattern.search(notice).group(1))
409 2019
410
Serhiy Storchakaa445feb2018-02-10 00:08:17 +0200411 (Contributed by Jonathan Eunice and Serhiy Storchaka in :issue:`30688`.)
Ned Deily07a18922018-01-31 18:12:38 -0500412
Rémi Lapeyre6531bf62018-11-06 01:38:54 +0100413* Dict and dictviews are now iterable in reversed insertion order using
414 :func:`reversed`. (Contributed by Rémi Lapeyre in :issue:`33462`.)
415
Benjamin Petersonc9a71dd2018-09-12 17:14:39 -0700416* The syntax allowed for keyword names in function calls was further
417 restricted. In particular, ``f((keyword)=arg)`` is no longer allowed. It was
418 never intended to permit more than a bare name on the left-hand side of a
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300419 keyword argument assignment term.
420 (Contributed by Benjamin Peterson in :issue:`34641`.)
Ned Deily07a18922018-01-31 18:12:38 -0500421
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700422* Generalized iterable unpacking in :keyword:`yield` and
423 :keyword:`return` statements no longer requires enclosing parentheses.
424 This brings the *yield* and *return* syntax into better agreement with
425 normal assignment syntax::
426
427 >>> def parse(family):
428 lastname, *members = family.split()
429 return lastname.upper(), *members
430
431 >>> parse('simpsons homer marge bart lisa sally')
432 ('SIMPSONS', 'homer', 'marge', 'bart', 'lisa', 'sally')
433
jChapman8fabae32018-09-22 21:13:10 -0400434 (Contributed by David Cuthbert and Jordan Chapman in :issue:`32117`.)
435
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700436* When a comma is missed in code such as ``[(10, 20) (30, 40)]``, the
437 compiler displays a :exc:`SyntaxWarning` with a helpful suggestion.
438 This improves on just having a :exc:`TypeError` indicating that the
439 first tuple was not callable. (Contributed by Serhiy Storchaka in
440 :issue:`15248`.)
Serhiy Storchaka62e44812019-02-16 08:12:19 +0200441
Paul Ganssled9503c32019-02-08 11:02:00 -0500442* Arithmetic operations between subclasses of :class:`datetime.date` or
443 :class:`datetime.datetime` and :class:`datetime.timedelta` objects now return
444 an instance of the subclass, rather than the base class. This also affects
445 the return type of operations whose implementation (directly or indirectly)
446 uses :class:`datetime.timedelta` arithmetic, such as
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700447 :meth:`~datetime.datetime.astimezone`.
Paul Ganssled9503c32019-02-08 11:02:00 -0500448 (Contributed by Paul Ganssle in :issue:`32417`.)
449
Gregory P. Smith06babb22019-02-23 10:43:49 -0800450* When the Python interpreter is interrupted by Ctrl-C (SIGINT) and the
451 resulting :exc:`KeyboardInterrupt` exception is not caught, the Python process
452 now exits via a SIGINT signal or with the correct exit code such that the
453 calling process can detect that it died due to a Ctrl-C. Shells on POSIX
454 and Windows use this to properly terminate scripts in interactive sessions.
455 (Contributed by Google via Gregory P. Smith in :issue:`1054041`.)
456
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700457* Some advanced styles of programming require updating the
458 :class:`types.CodeType` object for an existing function. Since code
459 objects are immutable, a new code object needs to be created, one
460 that is modeled on the existing code object. With 19 parameters,
461 this was somewhat tedious. Now, the new ``replace()`` method makes
462 it possible to create a clone with a few altered parameters.
463
464 Here's an example that alters the :func:`statistics.mean` function to
465 prevent the *data* parameter from being used as a keyword argument::
466
467 >>> from statistics import mean
468 >>> mean(data=[10, 20, 90])
469 40
470 >>> mean.__code__ = mean.__code__.replace(co_posonlyargcount=1)
471 >>> mean(data=[10, 20, 90])
472 Traceback (most recent call last):
473 ...
474 TypeError: mean() got some positional-only arguments passed as keyword arguments: 'data'
475
Victor Stinnera9f05d62019-05-24 23:57:23 +0200476 (Contributed by Victor Stinner in :issue:`37032`.)
477
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700478* For integers, the three-argument form of the :func:`pow` function now
479 permits the exponent to be negative in the case where the base is
480 relatively prime to the modulus. It then computes a modular inverse to
481 the base when the exponent is ``-1``, and a suitable power of that
482 inverse for other negative exponents. For example, to compute the
483 `modular multiplicative inverse
484 <https://en.wikipedia.org/wiki/Modular_multiplicative_inverse>`_ of 38
485 modulo 137, write::
486
487 >>> pow(38, -1, 137)
488 119
489 >>> 119 * 38 % 137
490 1
491
492 Modular inverses arise in the solution of `linear Diophantine
493 equations <https://en.wikipedia.org/wiki/Diophantine_equation>`_.
494 For example, to find integer solutions for ``4258𝑥 + 147𝑦 = 369``,
495 first rewrite as ``4258𝑥 ≡ 369 (mod 147)`` then solve:
496
497 >>> x = 369 * pow(4258, -1, 147) % 147
498 >>> y = (4258 * x - 369) // -147
499 >>> 4258 * x + 147 * y
500 369
501
Mark Dickinsonc5299672019-06-02 10:24:06 +0100502 (Contributed by Mark Dickinson in :issue:`36027`.)
503
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700504* Dict comprehensions have been synced-up with dict literals so that the
505 key is computed first and the value second::
506
507 >>> # Dict comprehension
508 >>> cast = {input('role? '): input('actor? ') for i in range(2)}
509 role? King Arthur
510 actor? Chapman
511 role? Black Knight
512 actor? Cleese
513
514 >>> # Dict literal
515 >>> cast = {input('role? '): input('actor? ')}
516 role? Sir Robin
517 actor? Eric Idle
518
519 The guaranteed execution order is helpful with assignment expressions
520 because variables assigned in the key expression will be available in
521 the value expression::
522
523 >>> names = ['Martin von Löwis', 'Łukasz Langa', 'Walter Dörwald']
524 >>> {(n := normalize('NFC', name)).casefold() : n for name in names}
525 {'martin von löwis': 'Martin von Löwis',
526 'łukasz langa': 'Łukasz Langa',
527 'walter dörwald': 'Walter Dörwald'}
Pablo Galindob51b7132019-06-25 02:41:58 +0100528
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300529 (Contributed by Jörn Heissler in :issue:`35224`.)
530
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700531* The :meth:`object.__reduce__` method can now return a tuple from two to
532 six elements long. Formerly, five was the limit. The new, optional sixth
533 element is a callable with a ``(obj, state)`` signature. This allows the
534 direct control over the state-updating behavior of a specific object. If
535 not *None*, this callable will have priority over the object's
536 :meth:`~__setstate__` method.
537 (Contributed by Pierre Glaser and Olivier Grisel in :issue:`35900`.)
Serhiy Storchaka65439122018-10-19 17:42:06 +0300538
Ned Deily07a18922018-01-31 18:12:38 -0500539New Modules
540===========
541
Barry Warsaw4867eaa2019-06-05 19:40:19 -0700542* The new :mod:`importlib.metadata` module provides (provisional) support for
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700543 reading metadata from third-party packages. For example, it can extract an
544 installed package's version number, list of entry points, and more::
545
546 >>> # Note following example requires that the popular "requests"
547 >>> # package has been installed.
548 >>>
549 >>> from importlib.metadata import version, requires, files
550 >>> version('requests')
551 '2.22.0'
552 >>> list(requires('requests'))
553 ['chardet (<3.1.0,>=3.0.2)']
554 >>> list(files('requests'))[:5]
555 [PackagePath('requests-2.22.0.dist-info/INSTALLER'),
556 PackagePath('requests-2.22.0.dist-info/LICENSE'),
557 PackagePath('requests-2.22.0.dist-info/METADATA'),
558 PackagePath('requests-2.22.0.dist-info/RECORD'),
559 PackagePath('requests-2.22.0.dist-info/WHEEL')]
560
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300561 (Contributed by Barry Warsaw and Jason R. Coombs in :issue:`34632`.)
Ned Deily07a18922018-01-31 18:12:38 -0500562
563
564Improved Modules
565================
566
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700567ast
568---
569
570AST nodes now have ``end_lineno`` and ``end_col_offset`` attributes,
571which give the precise location of the end of the node. (This only
572applies to nodes that have ``lineno`` and ``col_offset`` attributes.)
573
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300574New function :func:`ast.get_source_segment` returns the source code
575for a specific AST node.
576
577(Contributed by Ivan Levkivskyi in :issue:`33416`.)
578
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700579The :func:`ast.parse` function has some new flags:
580
581* ``type_comments=True`` causes it to return the text of :pep:`484` and
582 :pep:`526` type comments associated with certain AST nodes;
583
584* ``mode='func_type'`` can be used to parse :pep:`484` "signature type
585 comments" (returned for function definition AST nodes);
586
Guido van Rossum10b55c12019-06-11 17:23:12 -0700587* ``feature_version=(3, N)`` allows specifying an earlier Python 3
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700588 version. For example, ``feature_version=(3, 4)`` will treat
589 :keyword:`async` and :keyword:`await` as non-reserved words.
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700590
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300591(Contributed by Guido van Rossum in :issue:`35766`.)
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700592
593
Victor Stinner6ea29c52018-09-25 08:27:08 -0700594asyncio
595-------
596
Kyle Stanley3bbb6db2019-10-24 00:15:25 -0400597:func:`asyncio.run` has graduated from the provisional to stable API. This
598function can be used to execute a :term:`coroutine` and return the result while
599automatically managing the event loop. For example::
600
601 import asyncio
602
603 async def main():
604 await asyncio.sleep(0)
605 return 42
606
607 asyncio.run(main())
608
609This is *roughly* equivalent to::
610
611 import asyncio
612
613 async def main():
614 await asyncio.sleep(0)
615 return 42
616
617 loop = asyncio.new_event_loop()
618 asyncio.set_event_loop(loop)
619 try:
620 loop.run_until_complete(main())
621 finally:
622 asyncio.set_event_loop(None)
623 loop.close()
624
625
626The actual implementation is significantly more complex. Thus,
627:func:`asyncio.run` should be the preferred way of running asyncio programs.
628
629(Contributed by Yury Selivanov in :issue:`32314`.)
630
Raymond Hettinger274bd012019-10-14 09:01:05 -0700631Running ``python -m asyncio`` launches a natively async REPL. This allows rapid
632experimentation with code that has a top-level :keyword:`await`. There is no
633longer a need to directly call ``asyncio.run()`` which would spawn a new event
634loop on every invocation:
635
636.. code-block:: none
637
638 $ python -m asyncio
639 asyncio REPL 3.8.0
640 Use "await" directly instead of "asyncio.run()".
641 Type "help", "copyright", "credits" or "license" for more information.
642 >>> import asyncio
643 >>> await asyncio.sleep(10, result='hello')
644 hello
645
646(Contributed by Yury Selivanov in :issue:`37028`.)
647
Kyle Stanley3bbb6db2019-10-24 00:15:25 -0400648The exception :class:`asyncio.CancelledError` now inherits from
649:class:`BaseException` rather than :class:`Exception`.
650(Contributed by Yury Selivanov in :issue:`32528`.)
651
Victor Stinner6ea29c52018-09-25 08:27:08 -0700652On Windows, the default event loop is now :class:`~asyncio.ProactorEventLoop`.
Victor Stinner01ae8972019-06-03 16:28:01 +0200653(Contributed by Victor Stinner in :issue:`34687`.)
654
655:class:`~asyncio.ProactorEventLoop` now also supports UDP.
656(Contributed by Adam Meily and Andrew Svetlov in :issue:`29883`.)
657
658:class:`~asyncio.ProactorEventLoop` can now be interrupted by
659:exc:`KeyboardInterrupt` ("CTRL+C").
660(Contributed by Vladimir Matveev in :issue:`23057`.)
661
Kyle Stanley3bbb6db2019-10-24 00:15:25 -0400662Added :meth:`asyncio.Task.get_coro` for getting the wrapped coroutine
663within an :class:`asyncio.Task`.
664(Contributed by Alex Grönholm in :issue:`36999`.)
665
666Asyncio tasks can now be named, either by passing the ``name`` keyword
667argument to :func:`asyncio.create_task` or
668the :meth:`~asyncio.loop.create_task` event loop method, or by
669calling the :meth:`~asyncio.Task.set_name` method on the task object. The
670task name is visible in the ``repr()`` output of :class:`asyncio.Task` and
671can also be retrieved using the :meth:`~asyncio.Task.get_name` method.
672(Contributed by Alex Grönholm in :issue:`34270`.)
673
674Added support for
675`Happy Eyeballs <https://en.wikipedia.org/wiki/Happy_Eyeballs>`_ to
676:func:`asyncio.loop.create_connection`. To specify the behavior, two new
677parameters have been added: *happy_eyeballs_delay* and *interleave*. The Happy
678Eyeballs algorithm improves responsiveness in applications that support IPv4
679and IPv6 by attempting to simultaneously connect using both.
680(Contributed by twisteroid ambassador in :issue:`33530`.)
681
Victor Stinner6ea29c52018-09-25 08:27:08 -0700682
Matthias Bussonnier2ddbd212019-05-22 12:07:45 -0700683builtins
684--------
685
686The :func:`compile` built-in has been improved to accept the
687``ast.PyCF_ALLOW_TOP_LEVEL_AWAIT`` flag. With this new flag passed,
688:func:`compile` will allow top-level ``await``, ``async for`` and ``async with``
689constructs that are usually considered invalid syntax. Asynchronous code object
690marked with the ``CO_COROUTINE`` flag may then be returned.
Matthias Bussonnier2ddbd212019-05-22 12:07:45 -0700691(Contributed by Matthias Bussonnier in :issue:`34616`)
Terry Jan Reedyfdcb5ae2018-09-25 12:45:27 -0400692
Raymond Hettinger61a6db52019-10-13 21:31:12 -0700693
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700694collections
695-----------
696
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700697The :meth:`~collections.somenamedtuple._asdict` method for
698:func:`collections.namedtuple` now returns a :class:`dict` instead of a
699:class:`collections.OrderedDict`. This works because regular dicts have
700guaranteed ordering since Python 3.7. If the extra features of
701:class:`OrderedDict` are required, the suggested remediation is to cast the
702result to the desired type: ``OrderedDict(nt._asdict())``.
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700703(Contributed by Raymond Hettinger in :issue:`35864`.)
704
705
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700706cProfile
707--------
708
709The :class:`cProfile.Profile <profile.Profile>` class can now be used as a context manager.
710Profile a block of code by running::
711
712 import cProfile
713
714 with cProfile.Profile() as profiler:
715 # code to be profiled
716 ...
717
718(Contributed by Scott Sanderson in :issue:`29235`.)
719
720
721csv
722---
723
724The :class:`csv.DictReader` now returns instances of :class:`dict` instead of
725a :class:`collections.OrderedDict`. The tool is now faster and uses less
726memory while still preserving the field order.
fireattack9bfb4a72020-01-25 09:08:13 -0600727(Contributed by Michael Selik in :issue:`34003`.)
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700728
729
Raymond Hettinger61a6db52019-10-13 21:31:12 -0700730curses
731-------
732
733Added a new variable holding structured version information for the
734underlying ncurses library: :data:`~curses.ncurses_version`.
735(Contributed by Serhiy Storchaka in :issue:`31680`.)
736
737
Steve Dower2438cdf2019-03-29 16:37:16 -0700738ctypes
739------
740
741On Windows, :class:`~ctypes.CDLL` and subclasses now accept a *winmode* parameter
742to specify flags for the underlying ``LoadLibraryEx`` call. The default flags are
743set to only load DLL dependencies from trusted locations, including the path
744where the DLL is stored (if a full or partial path is used to load the initial
745DLL) and paths added by :func:`~os.add_dll_directory`.
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300746(Contributed by Steve Dower in :issue:`36085`.)
Steve Dower2438cdf2019-03-29 16:37:16 -0700747
748
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -0400749datetime
750--------
751
752Added new alternate constructors :meth:`datetime.date.fromisocalendar` and
753:meth:`datetime.datetime.fromisocalendar`, which construct :class:`date` and
754:class:`datetime` objects respectively from ISO year, week number, and weekday;
755these are the inverse of each class's ``isocalendar`` method.
756(Contributed by Paul Ganssle in :issue:`36004`.)
757
758
Raymond Hettingerb8218682019-05-26 11:27:35 -0700759functools
760---------
761
762:func:`functools.lru_cache` can now be used as a straight decorator rather
763than as a function returning a decorator. So both of these are now supported::
764
765 @lru_cache
766 def f(x):
767 ...
768
769 @lru_cache(maxsize=256)
770 def f(x):
771 ...
772
773(Contributed by Raymond Hettinger in :issue:`36772`.)
774
Stéphane Wirtel93b81e12019-10-18 09:14:18 +0200775Added a new :func:`functools.cached_property` decorator, for computed properties
776cached for the life of the instance. ::
777
778 import functools
779 import statistics
780
781 class Dataset:
782 def __init__(self, sequence_of_numbers):
783 self.data = sequence_of_numbers
784
785 @functools.cached_property
786 def variance(self):
787 return statistics.variance(self.data)
788
789(Contributed by Carl Meyer in :issue:`21145`)
790
Raymond Hettingerb8218682019-05-26 11:27:35 -0700791
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700792Added a new :func:`functools.singledispatchmethod` decorator that converts
793methods into :term:`generic functions <generic function>` using
794:term:`single dispatch`::
795
796 from functools import singledispatchmethod
797 from contextlib import suppress
798
799 class TaskManager:
800
801 def __init__(self, tasks):
802 self.tasks = list(tasks)
803
804 @singledispatchmethod
805 def discard(self, value):
806 with suppress(ValueError):
807 self.tasks.remove(value)
808
809 @discard.register(list)
810 def _(self, tasks):
811 targets = set(tasks)
812 self.tasks = [x for x in self.tasks if x not in targets]
813
814(Contributed by Ethan Smith in :issue:`32380`)
815
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -0400816gc
817--
Paul Ganssle88c09372019-04-29 09:22:03 -0400818
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -0400819:func:`~gc.get_objects` can now receive an optional *generation* parameter
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300820indicating a generation to get objects from.
821(Contributed by Pablo Galindo in :issue:`36016`.)
Paul Ganssle88c09372019-04-29 09:22:03 -0400822
823
Cheryl Sabella637a33b2018-11-07 09:12:20 -0500824gettext
825-------
826
827Added :func:`~gettext.pgettext` and its variants.
828(Contributed by Franz Glasner, Éric Araujo, and Cheryl Sabella in :issue:`2504`.)
829
Terry Jan Reedya72ca902019-07-31 01:03:53 -0400830
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -0400831gzip
832----
833
834Added the *mtime* parameter to :func:`gzip.compress` for reproducible output.
835(Contributed by Guo Ci Teo in :issue:`34898`.)
836
837A :exc:`~gzip.BadGzipFile` exception is now raised instead of :exc:`OSError`
838for certain types of invalid or corrupt gzip files.
839(Contributed by Filip Gruszczyński, Michele Orrù, and Zackery Spytz in
840:issue:`6584`.)
841
842
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700843IDLE and idlelib
Terry Jan Reedya72ca902019-07-31 01:03:53 -0400844----------------
845
846Output over N lines (50 by default) is squeezed down to a button.
847N can be changed in the PyShell section of the General page of the
848Settings dialog. Fewer, but possibly extra long, lines can be squeezed by
849right clicking on the output. Squeezed output can be expanded in place
850by double-clicking the button or into the clipboard or a separate window
851by right-clicking the button. (Contributed by Tal Einat in :issue:`1529353`.)
852
853Add "Run Customized" to the Run menu to run a module with customized
854settings. Any command line arguments entered are added to sys.argv.
855They also re-appear in the box for the next customized run. One can also
856suppress the normal Shell main module restart. (Contributed by Cheryl
857Sabella, Terry Jan Reedy, and others in :issue:`5680` and :issue:`37627`.)
858
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700859Added optional line numbers for IDLE editor windows. Windows
Terry Jan Reedya72ca902019-07-31 01:03:53 -0400860open without line numbers unless set otherwise in the General
861tab of the configuration dialog. Line numbers for an existing
862window are shown and hidden in the Options menu.
863(Contributed by Tal Einat and Saimadhav Heblikar in :issue:`17535`.)
864
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700865OS native encoding is now used for converting between Python strings and Tcl
866objects. This allows IDLE to work with emoji and other non-BMP characters.
867These characters can be displayed or copied and pasted to or from the
868clipboard. Converting strings from Tcl to Python and back now never fails.
869(Many people worked on this for eight years but the problem was finally
870solved by Serhiy Storchaka in :issue:`13153`.)
871
Terry Jan Reedya72ca902019-07-31 01:03:53 -0400872The changes above have been backported to 3.7 maintenance releases.
873
874
Raymond Hettingerd1e768a2019-03-25 13:01:13 -0700875inspect
876-------
877
878The :func:`inspect.getdoc` function can now find docstrings for ``__slots__``
879if that attribute is a :class:`dict` where the values are docstrings.
880This provides documentation options similar to what we already have
881for :func:`property`, :func:`classmethod`, and :func:`staticmethod`::
882
883 class AudioClip:
884 __slots__ = {'bit_rate': 'expressed in kilohertz to one decimal place',
885 'duration': 'in seconds, rounded up to an integer'}
886 def __init__(self, bit_rate, duration):
887 self.bit_rate = round(bit_rate / 1000.0, 1)
888 self.duration = ceil(duration)
Pablo Galindo175421b2019-02-23 03:02:06 +0000889
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300890(Contributed by Raymond Hettinger in :issue:`36326`.)
891
Terry Jan Reedya72ca902019-07-31 01:03:53 -0400892
Victor Stinnerbc2aa812019-05-23 03:45:09 +0200893io
894--
895
896In development mode (:option:`-X` ``env``) and in debug build, the
897:class:`io.IOBase` finalizer now logs the exception if the ``close()`` method
898fails. The exception is ignored silently by default in release build.
899(Contributed by Victor Stinner in :issue:`18748`.)
900
901
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700902itertools
903---------
904
905The :func:`itertools.accumulate` function added an option *initial* keyword
906argument to specify an initial value::
907
908 >>> from itertools import accumulate
909 >>> list(accumulate([10, 5, 30, 15], initial=1000))
910 [1000, 1010, 1015, 1045, 1060]
911
912(Contributed by Lisa Roach in :issue:`34659`.)
913
914
HongWeipengf1944792018-11-07 18:09:32 +0800915json.tool
916---------
917
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700918Add option ``--json-lines`` to parse every input line as a separate JSON object.
HongWeipengf1944792018-11-07 18:09:32 +0800919(Contributed by Weipeng Hong in :issue:`31553`.)
920
Pablo Galindobc098512019-02-07 07:04:02 +0000921
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700922logging
923-------
924
925Added a *force* keyword argument to :func:`logging.basicConfig()`
Serhiy Storchaka138ccbb2019-11-12 16:57:03 +0200926When set to true, any existing handlers attached
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700927to the root logger are removed and closed before carrying out the
928configuration specified by the other arguments.
929
930This solves a long-standing problem. Once a logger or *basicConfig()* had
931been called, subsequent calls to *basicConfig()* were silently ignored.
932This made it difficult to update, experiment with, or teach the various
933logging configuration options using the interactive prompt or a Jupyter
934notebook.
935
936(Suggested by Raymond Hettinger, implemented by Dong-hee Na, and
937reviewed by Vinay Sajip in :issue:`33897`.)
938
939
Pablo Galindobc098512019-02-07 07:04:02 +0000940math
941----
942
Raymond Hettinger3ff59622019-02-16 11:00:42 -0800943Added new function :func:`math.dist` for computing Euclidean distance
944between two points. (Contributed by Raymond Hettinger in :issue:`33089`.)
945
946Expanded the :func:`math.hypot` function to handle multiple dimensions.
947Formerly, it only supported the 2-D case.
948(Contributed by Raymond Hettinger in :issue:`33089`.)
949
Pablo Galindobc098512019-02-07 07:04:02 +0000950Added new function, :func:`math.prod`, as analogous function to :func:`sum`
951that returns the product of a 'start' value (default: 1) times an iterable of
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700952numbers::
953
954 >>> prior = 0.8
955 >>> likelihoods = [0.625, 0.84, 0.30]
Ashwin Vishnu1a8de822019-09-09 14:42:27 +0200956 >>> math.prod(likelihoods, start=prior)
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700957 0.126
958
Jero Badob1fa72a2019-10-18 15:48:48 +0800959(Contributed by Pablo Galindo in :issue:`35606`.)
Pablo Galindobc098512019-02-07 07:04:02 +0000960
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700961Added two new combinatoric functions :func:`math.perm` and :func:`math.comb`::
962
963 >>> math.perm(10, 3) # Permutations of 10 things taken 3 at a time
964 720
965 >>> math.comb(10, 3) # Combinations of 10 things taken 3 at a time
966 120
967
968(Contributed by Yash Aggarwal, Keller Fuchs, Serhiy Storchaka, and Raymond
969Hettinger in :issue:`37128`, :issue:`37178`, and :issue:`35431`.)
970
971Added a new function :func:`math.isqrt` for computing accurate integer square
972roots without conversion to floating point. The new function supports
973arbitrarily large integers. It is faster than ``floor(sqrt(n))`` but slower
974than :func:`math.sqrt`::
975
976 >>> r = 650320427
977 >>> s = r ** 2
978 >>> isqrt(s - 1) # correct
979 650320426
980 >>> floor(sqrt(s - 1)) # incorrect
981 650320427
982
Mark Dickinson73934b92019-05-18 12:29:50 +0100983(Contributed by Mark Dickinson in :issue:`36887`.)
984
Mark Dickinsona0adffb2019-06-01 12:21:53 +0100985The function :func:`math.factorial` no longer accepts arguments that are not
986int-like. (Contributed by Pablo Galindo in :issue:`33083`.)
987
Zackery Spytz02db6962019-05-27 10:48:17 -0600988
989mmap
990----
991
992The :class:`mmap.mmap` class now has an :meth:`~mmap.mmap.madvise` method to
993access the ``madvise()`` system call.
994(Contributed by Zackery Spytz in :issue:`32941`.)
995
996
Victor Stinner17a55882019-05-28 16:02:50 +0200997multiprocessing
998---------------
999
1000Added new :mod:`multiprocessing.shared_memory` module.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001001(Contributed by Davin Potts in :issue:`35813`.)
Victor Stinner17a55882019-05-28 16:02:50 +02001002
1003On macOS, the *spawn* start method is now used by default.
1004(Contributed by Victor Stinner in :issue:`33725`.)
1005
1006
Steve Dower2438cdf2019-03-29 16:37:16 -07001007os
1008--
1009
1010Added new function :func:`~os.add_dll_directory` on Windows for providing
1011additional search paths for native dependencies when importing extension
1012modules or loading DLLs using :mod:`ctypes`.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001013(Contributed by Steve Dower in :issue:`36085`.)
Steve Dower2438cdf2019-03-29 16:37:16 -07001014
Zackery Spytz43fdbd22019-05-29 13:57:07 -06001015A new :func:`os.memfd_create` function was added to wrap the
1016``memfd_create()`` syscall.
1017(Contributed by Zackery Spytz and Christian Heimes in :issue:`26836`.)
1018
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001019On Windows, much of the manual logic for handling reparse points (including
1020symlinks and directory junctions) has been delegated to the operating system.
1021Specifically, :func:`os.stat` will now traverse anything supported by the
1022operating system, while :func:`os.lstat` will only open reparse points that
1023identify as "name surrogates" while others are opened as for :func:`os.stat`.
1024In all cases, :attr:`stat_result.st_mode` will only have ``S_IFLNK`` set for
1025symbolic links and not other kinds of reparse points. To identify other kinds
1026of reparse point, check the new :attr:`stat_result.st_reparse_tag` attribute.
1027
1028On Windows, :func:`os.readlink` is now able to read directory junctions. Note
1029that :func:`~os.path.islink` will return ``False`` for directory junctions,
1030and so code that checks ``islink`` first will continue to treat junctions as
1031directories, while code that handles errors from :func:`os.readlink` may now
1032treat junctions as links.
1033
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001034(Contributed by Steve Dower in :issue:`37834`.)
1035
Pablo Galindobc098512019-02-07 07:04:02 +00001036
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001037os.path
1038-------
1039
1040:mod:`os.path` functions that return a boolean result like
1041:func:`~os.path.exists`, :func:`~os.path.lexists`, :func:`~os.path.isdir`,
1042:func:`~os.path.isfile`, :func:`~os.path.islink`, and :func:`~os.path.ismount`
1043now return ``False`` instead of raising :exc:`ValueError` or its subclasses
1044:exc:`UnicodeEncodeError` and :exc:`UnicodeDecodeError` for paths that contain
1045characters or bytes unrepresentable at the OS level.
1046(Contributed by Serhiy Storchaka in :issue:`33721`.)
1047
Steve Dower8ef864d2019-03-12 15:15:26 -07001048:func:`~os.path.expanduser` on Windows now prefers the :envvar:`USERPROFILE`
1049environment variable and does not use :envvar:`HOME`, which is not normally set
1050for regular user accounts.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001051(Contributed by Anthony Sottile in :issue:`36264`.)
Steve Dower8ef864d2019-03-12 15:15:26 -07001052
Serhiy Storchaka138ccbb2019-11-12 16:57:03 +02001053:func:`~os.path.isdir` on Windows no longer returns ``True`` for a link to a
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001054non-existent directory.
1055
Steve Dower75e06492019-08-21 13:43:06 -07001056:func:`~os.path.realpath` on Windows now resolves reparse points, including
1057symlinks and directory junctions.
1058
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001059(Contributed by Steve Dower in :issue:`37834`.)
1060
Serhiy Storchakab232df92018-10-30 13:22:42 +02001061
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001062pathlib
1063-------
1064
1065:mod:`pathlib.Path` methods that return a boolean result like
1066:meth:`~pathlib.Path.exists()`, :meth:`~pathlib.Path.is_dir()`,
1067:meth:`~pathlib.Path.is_file()`, :meth:`~pathlib.Path.is_mount()`,
1068:meth:`~pathlib.Path.is_symlink()`, :meth:`~pathlib.Path.is_block_device()`,
1069:meth:`~pathlib.Path.is_char_device()`, :meth:`~pathlib.Path.is_fifo()`,
1070:meth:`~pathlib.Path.is_socket()` now return ``False`` instead of raising
1071:exc:`ValueError` or its subclass :exc:`UnicodeEncodeError` for paths that
1072contain characters unrepresentable at the OS level.
1073(Contributed by Serhiy Storchaka in :issue:`33721`.)
1074
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -04001075Added :meth:`pathlib.Path.link_to()` which creates a hard link pointing
1076to a path.
1077(Contributed by Joannah Nanjekye in :issue:`26978`)
1078
jab9e00d9e2018-12-28 13:03:40 -05001079
Pierre Glaserec6c1bd2019-07-01 15:51:57 +02001080pickle
1081------
1082
Pierre Glaserec6c1bd2019-07-01 15:51:57 +02001083:mod:`pickle` extensions subclassing the C-optimized :class:`~pickle.Pickler`
1084can now override the pickling logic of functions and classes by defining the
1085special :meth:`~pickle.Pickler.reducer_override` method.
Jero Badob1fa72a2019-10-18 15:48:48 +08001086(Contributed by Pierre Glaser and Olivier Grisel in :issue:`35900`.)
Pierre Glaserec6c1bd2019-07-01 15:51:57 +02001087
1088
Jon Janzenc981ad12019-05-15 22:14:38 +02001089plistlib
1090--------
1091
1092Added new :class:`plistlib.UID` and enabled support for reading and writing
1093NSKeyedArchiver-encoded binary plists.
1094(Contributed by Jon Janzen in :issue:`26707`.)
1095
1096
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001097pprint
1098------
1099
1100The :mod:`pprint` module added a *sort_dicts* parameter to several functions.
1101By default, those functions continue to sort dictionaries before rendering or
Serhiy Storchaka138ccbb2019-11-12 16:57:03 +02001102printing. However, if *sort_dicts* is set to false, the dictionaries retain
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001103the order that keys were inserted. This can be useful for comparison to JSON
1104inputs during debugging.
1105
1106In addition, there is a convenience new function, :func:`pprint.pp` that is
Serhiy Storchaka138ccbb2019-11-12 16:57:03 +02001107like :func:`pprint.pprint` but with *sort_dicts* defaulting to ``False``::
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001108
1109 >>> from pprint import pprint, pp
1110 >>> d = dict(source='input.txt', operation='filter', destination='output.txt')
1111 >>> pp(d, width=40) # Original order
1112 {'source': 'input.txt',
1113 'operation': 'filter',
1114 'destination': 'output.txt'}
1115 >>> pprint(d, width=40) # Keys sorted alphabetically
1116 {'destination': 'output.txt',
1117 'operation': 'filter',
1118 'source': 'input.txt'}
1119
1120(Contributed by Rémi Lapeyre in :issue:`30670`.)
1121
1122
Joannah Nanjekye2e33ecd2019-05-28 13:29:04 -03001123py_compile
1124----------
1125
1126:func:`py_compile.compile` now supports silent mode.
1127(Contributed by Joannah Nanjekye in :issue:`22640`.)
1128
1129
Bo Baylesca804952019-05-29 03:06:12 -05001130shlex
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001131-----
Bo Baylesca804952019-05-29 03:06:12 -05001132
1133The new :func:`shlex.join` function acts as the inverse of :func:`shlex.split`.
1134(Contributed by Bo Bayles in :issue:`32102`.)
Giampaolo Rodolaeb7e29f2019-04-09 00:34:02 +02001135
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001136
jab9e00d9e2018-12-28 13:03:40 -05001137shutil
1138------
1139
1140:func:`shutil.copytree` now accepts a new ``dirs_exist_ok`` keyword argument.
1141(Contributed by Josh Bronson in :issue:`20849`.)
1142
CAM Gerlach89a89442019-04-06 23:47:49 -05001143:func:`shutil.make_archive` now defaults to the modern pax (POSIX.1-2001)
1144format for new archives to improve portability and standards conformance,
1145inherited from the corresponding change to the :mod:`tarfile` module.
1146(Contributed by C.A.M. Gerlach in :issue:`30661`.)
1147
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001148:func:`shutil.rmtree` on Windows now removes directory junctions without
1149recursively removing their contents first.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001150(Contributed by Steve Dower in :issue:`37834`.)
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001151
jab9e00d9e2018-12-28 13:03:40 -05001152
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001153socket
1154------
1155
1156Added :meth:`~socket.create_server()` and :meth:`~socket.has_dualstack_ipv6()`
1157convenience functions to automate the necessary tasks usually involved when
1158creating a server socket, including accepting both IPv4 and IPv6 connections
1159on the same socket. (Contributed by Giampaolo Rodolà in :issue:`17561`.)
1160
1161The :func:`socket.if_nameindex()`, :func:`socket.if_nametoindex()`, and
1162:func:`socket.if_indextoname()` functions have been implemented on Windows.
1163(Contributed by Zackery Spytz in :issue:`37007`.)
1164
1165
Christian Heimes9fb051f2018-09-23 08:32:31 +02001166ssl
1167---
1168
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001169Added :attr:`~ssl.SSLContext.post_handshake_auth` to enable and
1170:meth:`~ssl.SSLSocket.verify_client_post_handshake` to initiate TLS 1.3
Christian Heimes9fb051f2018-09-23 08:32:31 +02001171post-handshake authentication.
1172(Contributed by Christian Heimes in :issue:`34670`.)
1173
Raymond Hettinger47d99872019-02-21 15:06:29 -08001174
1175statistics
1176----------
1177
1178Added :func:`statistics.fmean` as a faster, floating point variant of
1179:func:`statistics.mean()`. (Contributed by Raymond Hettinger and
1180Steven D'Aprano in :issue:`35904`.)
1181
Raymond Hettinger6463ba32019-04-07 09:20:03 -07001182Added :func:`statistics.geometric_mean()`
1183(Contributed by Raymond Hettinger in :issue:`27181`.)
1184
Raymond Hettingerfc06a192019-03-12 00:43:27 -07001185Added :func:`statistics.multimode` that returns a list of the most
1186common values. (Contributed by Raymond Hettinger in :issue:`35892`.)
1187
Raymond Hettinger9013ccf2019-04-23 00:06:35 -07001188Added :func:`statistics.quantiles` that divides data or a distribution
1189in to equiprobable intervals (e.g. quartiles, deciles, or percentiles).
1190(Contributed by Raymond Hettinger in :issue:`36546`.)
1191
Raymond Hettinger11c79532019-02-23 14:44:07 -08001192Added :class:`statistics.NormalDist`, a tool for creating
1193and manipulating normal distributions of a random variable.
1194(Contributed by Raymond Hettinger in :issue:`36018`.)
1195
1196::
1197
1198 >>> temperature_feb = NormalDist.from_samples([4, 12, -3, 2, 7, 14])
Raymond Hettinger671d7822019-05-01 17:49:12 -07001199 >>> temperature_feb.mean
1200 6.0
1201 >>> temperature_feb.stdev
1202 6.356099432828281
Raymond Hettinger11c79532019-02-23 14:44:07 -08001203
1204 >>> temperature_feb.cdf(3) # Chance of being under 3 degrees
1205 0.3184678262814532
1206 >>> # Relative chance of being 7 degrees versus 10 degrees
1207 >>> temperature_feb.pdf(7) / temperature_feb.pdf(10)
1208 1.2039930378537762
1209
Raymond Hettinger671d7822019-05-01 17:49:12 -07001210 >>> el_niño = NormalDist(4, 2.5)
1211 >>> temperature_feb += el_niño # Add in a climate effect
Raymond Hettinger11c79532019-02-23 14:44:07 -08001212 >>> temperature_feb
1213 NormalDist(mu=10.0, sigma=6.830080526611674)
1214
1215 >>> temperature_feb * (9/5) + 32 # Convert to Fahrenheit
1216 NormalDist(mu=50.0, sigma=12.294144947901014)
1217 >>> temperature_feb.samples(3) # Generate random samples
1218 [7.672102882379219, 12.000027119750287, 4.647488369766392]
1219
Raymond Hettinger47d99872019-02-21 15:06:29 -08001220
Victor Stinneref9d9b62019-05-22 11:28:22 +02001221sys
1222---
1223
1224Add new :func:`sys.unraisablehook` function which can be overridden to control
1225how "unraisable exceptions" are handled. It is called when an exception has
1226occurred but there is no way for Python to handle it. For example, when a
1227destructor raises an exception or during garbage collection
1228(:func:`gc.collect`).
Victor Stinner01ae8972019-06-03 16:28:01 +02001229(Contributed by Victor Stinner in :issue:`36829`.)
Victor Stinneref9d9b62019-05-22 11:28:22 +02001230
1231
CAM Gerlache680c3d2019-03-21 09:44:51 -05001232tarfile
1233-------
1234
1235The :mod:`tarfile` module now defaults to the modern pax (POSIX.1-2001)
1236format for new archives, instead of the previous GNU-specific one.
1237This improves cross-platform portability with a consistent encoding (UTF-8)
1238in a standardized and extensible format, and offers several other benefits.
1239(Contributed by C.A.M. Gerlach in :issue:`36268`.)
1240
1241
Victor Stinnercd590a72019-05-28 00:39:52 +02001242threading
1243---------
1244
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001245Add a new :func:`threading.excepthook` function which handles uncaught
1246:meth:`threading.Thread.run` exception. It can be overridden to control how
1247uncaught :meth:`threading.Thread.run` exceptions are handled.
1248(Contributed by Victor Stinner in :issue:`1230540`.)
Jake Tesler84846b02019-07-30 14:41:46 -07001249
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001250Add a new :func:`threading.get_native_id` function and
1251a :data:`~threading.Thread.native_id`
1252attribute to the :class:`threading.Thread` class. These return the native
1253integral Thread ID of the current thread assigned by the kernel.
1254This feature is only available on certain platforms, see
1255:func:`get_native_id <threading.get_native_id>` for more information.
1256(Contributed by Jake Tesler in :issue:`36084`.)
Victor Stinnercd590a72019-05-28 00:39:52 +02001257
1258
Tal Einatdfba1f62018-10-24 10:20:05 +03001259tokenize
1260--------
1261
1262The :mod:`tokenize` module now implicitly emits a ``NEWLINE`` token when
1263provided with input that does not have a trailing new line. This behavior
1264now matches what the C tokenizer does internally.
1265(Contributed by Ammar Askar in :issue:`33899`.)
1266
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001267
Juliette Monselaf5658a2018-10-08 18:29:24 +02001268tkinter
1269-------
1270
1271Added methods :meth:`~tkinter.Spinbox.selection_from`,
1272:meth:`~tkinter.Spinbox.selection_present`,
1273:meth:`~tkinter.Spinbox.selection_range` and
1274:meth:`~tkinter.Spinbox.selection_to`
1275in the :class:`tkinter.Spinbox` class.
1276(Contributed by Juliette Monsel in :issue:`34829`.)
1277
Juliette Monselbf034712018-10-12 18:44:10 +02001278Added method :meth:`~tkinter.Canvas.moveto`
1279in the :class:`tkinter.Canvas` class.
1280(Contributed by Juliette Monsel in :issue:`23831`.)
1281
Zackery Spytz50866e92019-04-05 04:17:13 -06001282The :class:`tkinter.PhotoImage` class now has
1283:meth:`~tkinter.PhotoImage.transparency_get` and
1284:meth:`~tkinter.PhotoImage.transparency_set` methods. (Contributed by
1285Zackery Spytz in :issue:`25451`.)
1286
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001287
Joannah Nanjekye572168a2019-01-10 19:56:38 +03001288time
1289----
1290
1291Added new clock :data:`~time.CLOCK_UPTIME_RAW` for macOS 10.12.
1292(Contributed by Joannah Nanjekye in :issue:`35702`.)
1293
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001294
1295typing
1296------
1297
1298The :mod:`typing` module incorporates several new features:
1299
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001300* A dictionary type with per-key types. See :pep:`589` and
1301 :class:`typing.TypedDict`.
Raymond Hettingera3291532019-10-13 23:32:03 -07001302 TypedDict uses only string keys. By default, every key is required
1303 to be present. Specify "total=False" to allow keys to be optional::
1304
1305 class Location(TypedDict, total=False):
1306 lat_long: tuple
1307 grid_square: str
1308 xy_coordinate: tuple
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001309
1310* Literal types. See :pep:`586` and :class:`typing.Literal`.
Raymond Hettingera3291532019-10-13 23:32:03 -07001311 Literal types indicate that a parameter or return value
1312 is constrained to one or more specific literal values::
1313
1314 def get_status(port: int) -> Literal['connected', 'disconnected']:
1315 ...
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001316
1317* "Final" variables, functions, methods and classes. See :pep:`591`,
1318 :class:`typing.Final` and :func:`typing.final`.
Raymond Hettingera3291532019-10-13 23:32:03 -07001319 The final qualifier instructs a static type checker to restrict
1320 subclassing, overriding, or reassignment::
1321
1322 pi: Final[float] = 3.1415926536
1323
1324* Protocol definitions. See :pep:`544`, :class:`typing.Protocol` and
1325 :func:`typing.runtime_checkable`. Simple ABCs like
1326 :class:`typing.SupportsInt` are now ``Protocol`` subclasses.
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001327
1328* New protocol class :class:`typing.SupportsIndex`.
1329
1330* New functions :func:`typing.get_origin` and :func:`typing.get_args`.
1331
1332
Max Bélanger2810dd72018-11-04 15:58:24 -08001333unicodedata
1334-----------
1335
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001336The :mod:`unicodedata` module has been upgraded to use the `Unicode 12.1.0
1337<http://blog.unicode.org/2019/05/unicode-12-1-en.html>`_ release.
Raymond Hettinger482b6b52019-05-01 17:48:13 -07001338
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001339New function :func:`~unicodedata.is_normalized` can be used to verify a string
1340is in a specific normal form, often much faster than by actually normalizing
1341the string. (Contributed by Max Belanger, David Euresti, and Greg Price in
1342:issue:`32285` and :issue:`37966`).
Max Bélanger2810dd72018-11-04 15:58:24 -08001343
Raymond Hettinger482b6b52019-05-01 17:48:13 -07001344
Lisa Roach0f221d02018-11-08 18:34:33 -08001345unittest
1346--------
1347
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001348Added :class:`~unittest.mock.AsyncMock` to support an asynchronous version of
1349:class:`~unittest.mock.Mock`. Appropriate new assert functions for testing
1350have been added as well.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001351(Contributed by Lisa Roach in :issue:`26467`).
Lisa Roach77b3b772019-05-20 09:19:53 -07001352
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001353Added :func:`~unittest.addModuleCleanup()` and
1354:meth:`~unittest.TestCase.addClassCleanup()` to unittest to support
1355cleanups for :func:`~unittest.setUpModule()` and
1356:meth:`~unittest.TestCase.setUpClass()`.
1357(Contributed by Lisa Roach in :issue:`24412`.)
Lisa Roach0f221d02018-11-08 18:34:33 -08001358
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001359Several mock assert functions now also print a list of actual calls upon
1360failure. (Contributed by Petter Strandmark in :issue:`35047`.)
Petter Strandmark001d63c2019-06-04 21:34:49 +02001361
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001362:mod:`unittest` module gained support for coroutines to be used as test cases
1363with :class:`unittest.IsolatedAsyncioTestCase`.
1364(Contributed by Andrew Svetlov in :issue:`32972`.)
Xtreak6a9fd662019-09-11 12:02:14 +01001365
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001366Example::
Xtreak6a9fd662019-09-11 12:02:14 +01001367
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001368 import unittest
Xtreak6a9fd662019-09-11 12:02:14 +01001369
1370
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001371 class TestRequest(unittest.IsolatedAsyncioTestCase):
Xtreak6a9fd662019-09-11 12:02:14 +01001372
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001373 async def asyncSetUp(self):
1374 self.connection = await AsyncConnection()
Xtreak6a9fd662019-09-11 12:02:14 +01001375
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001376 async def test_get(self):
1377 response = await self.connection.get("https://example.com")
1378 self.assertEqual(response.status_code, 200)
Xtreak6a9fd662019-09-11 12:02:14 +01001379
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001380 async def asyncTearDown(self):
1381 await self.connection.close()
Xtreak6a9fd662019-09-11 12:02:14 +01001382
1383
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001384 if __name__ == "__main__":
1385 unittest.main()
Xtreak6a9fd662019-09-11 12:02:14 +01001386
1387
Brett Cannond64ee1a2018-09-21 15:27:26 -07001388venv
1389----
1390
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001391:mod:`venv` now includes an ``Activate.ps1`` script on all platforms for
1392activating virtual environments under PowerShell Core 6.1.
1393(Contributed by Brett Cannon in :issue:`32718`.)
1394
Brett Cannond64ee1a2018-09-21 15:27:26 -07001395
Mark Dickinson7abb6c02019-04-26 15:56:15 +09001396weakref
1397-------
1398
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001399The proxy objects returned by :func:`weakref.proxy` now support the matrix
1400multiplication operators ``@`` and ``@=`` in addition to the other
1401numeric operators. (Contributed by Mark Dickinson in :issue:`36669`.)
1402
Mark Dickinson7abb6c02019-04-26 15:56:15 +09001403
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001404xml
1405---
1406
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001407As mitigation against DTD and external entity retrieval, the
1408:mod:`xml.dom.minidom` and :mod:`xml.sax` modules no longer process
1409external entities by default.
1410(Contributed by Christian Heimes in :issue:`17239`.)
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001411
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001412The ``.find*()`` methods in the :mod:`xml.etree.ElementTree` module
1413support wildcard searches like ``{*}tag`` which ignores the namespace
1414and ``{namespace}*`` which returns all tags in the given namespace.
1415(Contributed by Stefan Behnel in :issue:`28238`.)
Stefan Behnel47541682019-05-03 20:58:16 +02001416
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001417The :mod:`xml.etree.ElementTree` module provides a new function
1418:func:`–xml.etree.ElementTree.canonicalize()` that implements C14N 2.0.
1419(Contributed by Stefan Behnel in :issue:`13611`.)
Stefan Behnele1d5dd62019-05-01 22:34:13 +02001420
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001421The target object of :class:`xml.etree.ElementTree.XMLParser` can
1422receive namespace declaration events through the new callback methods
1423``start_ns()`` and ``end_ns()``. Additionally, the
1424:class:`xml.etree.ElementTree.TreeBuilder` target can be configured
1425to process events about comments and processing instructions to include
1426them in the generated tree.
1427(Contributed by Stefan Behnel in :issue:`36676` and :issue:`36673`.)
1428
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001429
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001430xmlrpc
1431------
1432
1433:class:`xmlrpc.client.ServerProxy` now supports an optional *headers* keyword
1434argument for a sequence of HTTP headers to be sent with each request. Among
1435other things, this makes it possible to upgrade from default basic
1436authentication to faster session authentication.
1437(Contributed by Cédric Krier in :issue:`35153`.)
1438
1439
Ned Deily07a18922018-01-31 18:12:38 -05001440Optimizations
1441=============
1442
Victor Stinner9daecf32019-01-16 00:02:35 +01001443* The :mod:`subprocess` module can now use the :func:`os.posix_spawn` function
1444 in some cases for better performance. Currently, it is only used on macOS
1445 and Linux (using glibc 2.24 or newer) if all these conditions are met:
1446
1447 * *close_fds* is false;
Victor Stinnerf6243ac2019-01-23 19:00:39 +01001448 * *preexec_fn*, *pass_fds*, *cwd* and *start_new_session* parameters
1449 are not set;
Victor Stinner8c349562019-01-16 23:38:06 +01001450 * the *executable* path contains a directory.
Victor Stinner9daecf32019-01-16 00:02:35 +01001451
Victor Stinner01ae8972019-06-03 16:28:01 +02001452 (Contributed by Joannah Nanjekye and Victor Stinner in :issue:`35537`.)
1453
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02001454* :func:`shutil.copyfile`, :func:`shutil.copy`, :func:`shutil.copy2`,
1455 :func:`shutil.copytree` and :func:`shutil.move` use platform-specific
Giampaolo Rodola413d9552019-05-30 14:05:41 +08001456 "fast-copy" syscalls on Linux and macOS in order to copy the file
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07001457 more efficiently.
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02001458 "fast-copy" means that the copying operation occurs within the kernel,
1459 avoiding the use of userspace buffers in Python as in
1460 "``outfd.write(infd.read())``".
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07001461 On Windows :func:`shutil.copyfile` uses a bigger default buffer size (1 MiB
1462 instead of 16 KiB) and a :func:`memoryview`-based variant of
1463 :func:`shutil.copyfileobj` is used.
1464 The speedup for copying a 512 MiB file within the same partition is about
1465 +26% on Linux, +50% on macOS and +40% on Windows. Also, much less CPU cycles
1466 are consumed.
1467 See :ref:`shutil-platform-dependent-efficient-copy-operations` section.
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001468 (Contributed by Giampaolo Rodolà in :issue:`33671`.)
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02001469
Giampaolo Rodola19c46a42018-11-12 06:18:15 -08001470* :func:`shutil.copytree` uses :func:`os.scandir` function and all copy
1471 functions depending from it use cached :func:`os.stat` values. The speedup
1472 for copying a directory with 8000 files is around +9% on Linux, +20% on
1473 Windows and +30% on a Windows SMB share. Also the number of :func:`os.stat`
1474 syscalls is reduced by 38% making :func:`shutil.copytree` especially faster
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001475 on network filesystems. (Contributed by Giampaolo Rodolà in :issue:`33695`.)
Giampaolo Rodola19c46a42018-11-12 06:18:15 -08001476
Łukasz Langac51d8c92018-04-03 23:06:53 -07001477* The default protocol in the :mod:`pickle` module is now Protocol 4,
1478 first introduced in Python 3.4. It offers better performance and smaller
1479 size compared to Protocol 3 available since Python 3.0.
Ned Deily07a18922018-01-31 18:12:38 -05001480
INADA Naokid5c875b2018-07-11 17:42:49 +09001481* Removed one ``Py_ssize_t`` member from ``PyGC_Head``. All GC tracked
1482 objects (e.g. tuple, list, dict) size is reduced 4 or 8 bytes.
Jero Badob1fa72a2019-10-18 15:48:48 +08001483 (Contributed by Inada Naoki in :issue:`33597`.)
INADA Naokid5c875b2018-07-11 17:42:49 +09001484
Tal Einat54752532018-09-10 16:11:04 +03001485* :class:`uuid.UUID` now uses ``__slots__`` to reduce its memory footprint.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001486 (Contributed by Wouter Bolsterlee and Tal Einat in :issue:`30977`)
Tal Einat54752532018-09-10 16:11:04 +03001487
Raymond Hettinger63fa1cf2019-02-16 12:02:22 -08001488* Improved performance of :func:`operator.itemgetter` by 33%. Optimized
1489 argument handling and added a fast path for the common case of a single
1490 non-negative integer index into a tuple (which is the typical use case in
1491 the standard library). (Contributed by Raymond Hettinger in
1492 :issue:`35664`.)
1493
1494* Sped-up field lookups in :func:`collections.namedtuple`. They are now more
1495 than two times faster, making them the fastest form of instance variable
1496 lookup in Python. (Contributed by Raymond Hettinger, Pablo Galindo, and
Joe Jevnikf36f8922019-02-21 16:00:40 -05001497 Joe Jevnik, Serhiy Storchaka in :issue:`32492`.)
Raymond Hettinger63fa1cf2019-02-16 12:02:22 -08001498
Pablo Galindoc61e2292018-10-28 22:03:18 +00001499* The :class:`list` constructor does not overallocate the internal item buffer
1500 if the input iterable has a known length (the input implements ``__len__``).
Raymond Hettingere1823182019-02-16 12:47:48 -08001501 This makes the created list 12% smaller on average. (Contributed by
1502 Raymond Hettinger and Pablo Galindo in :issue:`33234`.)
Pablo Galindoc61e2292018-10-28 22:03:18 +00001503
Stefan Behneld8b9e1f2019-02-20 18:29:24 +01001504* Doubled the speed of class variable writes. When a non-dunder attribute
1505 was updated, there was an unnecessary call to update slots.
1506 (Contributed by Stefan Behnel, Pablo Galindo Salgado, Raymond Hettinger,
1507 Neil Schemenauer, and Serhiy Storchaka in :issue:`36012`.)
1508
Serhiy Storchaka31913912019-03-14 10:32:22 +02001509* Reduced an overhead of converting arguments passed to many builtin functions
1510 and methods. This sped up calling some simple builtin functions and
1511 methods up to 20--50%. (Contributed by Serhiy Storchaka in :issue:`23867`,
1512 :issue:`35582` and :issue:`36127`.)
1513
Inada Naoki91234a12019-06-03 21:30:58 +09001514* ``LOAD_GLOBAL`` instruction now uses new "per opcode cache" mechanism.
1515 It is about 40% faster now. (Contributed by Yury Selivanov and Inada Naoki in
1516 :issue:`26219`.)
1517
Serhiy Storchakaceeef102018-06-15 11:09:43 +03001518
Ned Deily07a18922018-01-31 18:12:38 -05001519Build and C API Changes
1520=======================
1521
Victor Stinner7efc5262019-06-15 03:24:41 +02001522* Default :data:`sys.abiflags` became an empty string: the ``m`` flag for
1523 pymalloc became useless (builds with and without pymalloc are ABI compatible)
1524 and so has been removed. (Contributed by Victor Stinner in :issue:`36707`.)
1525
1526 Example of changes:
1527
1528 * Only ``python3.8`` program is installed, ``python3.8m`` program is gone.
1529 * Only ``python3.8-config`` script is installed, ``python3.8m-config`` script
1530 is gone.
1531 * The ``m`` flag has been removed from the suffix of dynamic library
1532 filenames: extension modules in the standard library as well as those
1533 produced and installed by third-party packages, like those downloaded from
1534 PyPI. On Linux, for example, the Python 3.7 suffix
1535 ``.cpython-37m-x86_64-linux-gnu.so`` became
1536 ``.cpython-38-x86_64-linux-gnu.so`` in Python 3.8.
1537
Victor Stinnerbd5798f2019-06-14 19:43:43 +02001538* The header files have been reorganized to better separate the different kinds
1539 of APIs:
1540
1541 * ``Include/*.h`` should be the portable public stable C API.
1542 * ``Include/cpython/*.h`` should be the unstable C API specific to CPython;
Victor Stinneraf41c562019-06-20 01:44:58 +02001543 public API, with some private API prefixed by ``_Py`` or ``_PY``.
Victor Stinnerbd5798f2019-06-14 19:43:43 +02001544 * ``Include/internal/*.h`` is the private internal C API very specific to
1545 CPython. This API comes with no backward compatibility warranty and should
1546 not be used outside CPython. It is only exposed for very specific needs
1547 like debuggers and profiles which has to access to CPython internals
1548 without calling functions. This API is now installed by ``make install``.
1549
1550 (Contributed by Victor Stinner in :issue:`35134` and :issue:`35081`,
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001551 work initiated by Eric Snow in Python 3.7.)
Victor Stinnerbd5798f2019-06-14 19:43:43 +02001552
1553* Some macros have been converted to static inline functions: parameter types
1554 and return type are well defined, they don't have issues specific to macros,
1555 variables have a local scopes. Examples:
1556
1557 * :c:func:`Py_INCREF`, :c:func:`Py_DECREF`
1558 * :c:func:`Py_XINCREF`, :c:func:`Py_XDECREF`
1559 * :c:func:`PyObject_INIT`, :c:func:`PyObject_INIT_VAR`
1560 * Private functions: :c:func:`_PyObject_GC_TRACK`,
1561 :c:func:`_PyObject_GC_UNTRACK`, :c:func:`_Py_Dealloc`
1562
1563 (Contributed by Victor Stinner in :issue:`35059`.)
1564
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001565* The :c:func:`PyByteArray_Init` and :c:func:`PyByteArray_Fini` functions have
1566 been removed. They did nothing since Python 2.7.4 and Python 3.2.0, were
1567 excluded from the limited API (stable ABI), and were not documented.
Victor Stinnerc68e3fb2019-06-20 22:41:25 +02001568 (Contributed by Victor Stinner in :issue:`35713`.)
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001569
Serhiy Storchakaceeef102018-06-15 11:09:43 +03001570* The result of :c:func:`PyExceptionClass_Name` is now of type
1571 ``const char *`` rather of ``char *``.
1572 (Contributed by Serhiy Storchaka in :issue:`33818`.)
Ned Deily07a18922018-01-31 18:12:38 -05001573
Antoine Pitrou961d54c2018-07-16 19:03:03 +02001574* The duality of ``Modules/Setup.dist`` and ``Modules/Setup`` has been
1575 removed. Previously, when updating the CPython source tree, one had
1576 to manually copy ``Modules/Setup.dist`` (inside the source tree) to
1577 ``Modules/Setup`` (inside the build tree) in order to reflect any changes
1578 upstream. This was of a small benefit to packagers at the expense of
1579 a frequent annoyance to developers following CPython development, as
1580 forgetting to copy the file could produce build failures.
1581
1582 Now the build system always reads from ``Modules/Setup`` inside the source
1583 tree. People who want to customize that file are encouraged to maintain
1584 their changes in a git fork of CPython or as patch files, as they would do
1585 for any other change to the source tree.
1586
1587 (Contributed by Antoine Pitrou in :issue:`32430`.)
1588
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001589* Functions that convert Python number to C integer like
1590 :c:func:`PyLong_AsLong` and argument parsing functions like
1591 :c:func:`PyArg_ParseTuple` with integer converting format units like ``'i'``
1592 will now use the :meth:`~object.__index__` special method instead of
1593 :meth:`~object.__int__`, if available. The deprecation warning will be
1594 emitted for objects with the ``__int__()`` method but without the
1595 ``__index__()`` method (like :class:`~decimal.Decimal` and
1596 :class:`~fractions.Fraction`). :c:func:`PyNumber_Check` will now return
1597 ``1`` for objects implementing ``__index__()``.
Serhiy Storchakabdbad712019-06-02 00:05:48 +03001598 :c:func:`PyNumber_Long`, :c:func:`PyNumber_Float` and
1599 :c:func:`PyFloat_AsDouble` also now use the ``__index__()`` method if
1600 available.
1601 (Contributed by Serhiy Storchaka in :issue:`36048` and :issue:`20092`.)
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001602
Eddie Elizondo364f0b02019-03-27 07:52:18 -04001603* Heap-allocated type objects will now increase their reference count
1604 in :c:func:`PyObject_Init` (and its parallel macro ``PyObject_INIT``)
1605 instead of in :c:func:`PyType_GenericAlloc`. Types that modify instance
1606 allocation or deallocation may need to be adjusted.
1607 (Contributed by Eddie Elizondo in :issue:`35810`.)
1608
Pablo Galindo4a2edc32019-07-01 11:35:05 +01001609* The new function :c:func:`PyCode_NewWithPosOnlyArgs` allows to create
1610 code objects like :c:func:`PyCode_New`, but with an extra *posonlyargcount*
1611 parameter for indicating the number of positional-only arguments.
1612 (Contributed by Pablo Galindo in :issue:`37221`.)
1613
Victor Stinner1ce152a2019-09-24 17:44:15 +02001614* :c:func:`Py_SetPath` now sets :data:`sys.executable` to the program full
1615 path (:c:func:`Py_GetProgramFullPath`) rather than to the program name
1616 (:c:func:`Py_GetProgramName`).
1617 (Contributed by Victor Stinner in :issue:`38234`.)
1618
Ned Deily07a18922018-01-31 18:12:38 -05001619
1620Deprecated
1621==========
1622
Victor Stinner1da44622019-07-05 10:44:12 +02001623* The distutils ``bdist_wininst`` command is now deprecated, use
1624 ``bdist_wheel`` (wheel packages) instead.
1625 (Contributed by Victor Stinner in :issue:`37481`.)
1626
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001627* Deprecated methods ``getchildren()`` and ``getiterator()`` in
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001628 the :mod:`~xml.etree.ElementTree` module now emit a
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001629 :exc:`DeprecationWarning` instead of :exc:`PendingDeprecationWarning`.
1630 They will be removed in Python 3.9.
1631 (Contributed by Serhiy Storchaka in :issue:`29209`.)
Ned Deily07a18922018-01-31 18:12:38 -05001632
Elvis Pranskevichus22d25082018-07-30 11:42:43 +01001633* Passing an object that is not an instance of
1634 :class:`concurrent.futures.ThreadPoolExecutor` to
Kyle Stanley3bbb6db2019-10-24 00:15:25 -04001635 :meth:`loop.set_default_executor() <asyncio.loop.set_default_executor>` is
Elvis Pranskevichus22d25082018-07-30 11:42:43 +01001636 deprecated and will be prohibited in Python 3.9.
1637 (Contributed by Elvis Pranskevichus in :issue:`34075`.)
1638
Berker Peksagef8861c2018-08-21 17:58:49 +03001639* The :meth:`__getitem__` methods of :class:`xml.dom.pulldom.DOMEventStream`,
1640 :class:`wsgiref.util.FileWrapper` and :class:`fileinput.FileInput` have been
1641 deprecated.
1642
1643 Implementations of these methods have been ignoring their *index* parameter,
1644 and returning the next item instead.
Berker Peksagef8861c2018-08-21 17:58:49 +03001645 (Contributed by Berker Peksag in :issue:`9372`.)
1646
Raymond Hettingerf7b57df2019-03-18 09:53:56 -07001647* The :class:`typing.NamedTuple` class has deprecated the ``_field_types``
1648 attribute in favor of the ``__annotations__`` attribute which has the same
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001649 information. (Contributed by Raymond Hettinger in :issue:`36320`.)
Raymond Hettingerf7b57df2019-03-18 09:53:56 -07001650
Serhiy Storchaka3f228112018-09-27 17:42:37 +03001651* :mod:`ast` classes ``Num``, ``Str``, ``Bytes``, ``NameConstant`` and
1652 ``Ellipsis`` are considered deprecated and will be removed in future Python
1653 versions. :class:`~ast.Constant` should be used instead.
1654 (Contributed by Serhiy Storchaka in :issue:`32892`.)
1655
Serhiy Storchakac3ea41e2019-08-26 10:13:19 +03001656* :class:`ast.NodeVisitor` methods ``visit_Num()``, ``visit_Str()``,
1657 ``visit_Bytes()``, ``visit_NameConstant()`` and ``visit_Ellipsis()`` are
1658 deprecated now and will not be called in future Python versions.
1659 Add the :meth:`~ast.NodeVisitor.visit_Constant` method to handle all
1660 constant nodes.
1661 (Contributed by Serhiy Storchaka in :issue:`36917`.)
1662
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001663* The :func:`asyncio.coroutine` :term:`decorator` is deprecated and will be
1664 removed in version 3.10. Instead of ``@asyncio.coroutine``, use
1665 :keyword:`async def` instead.
1666 (Contributed by Andrew Svetlov in :issue:`36921`.)
1667
Kyle Stanley3bbb6db2019-10-24 00:15:25 -04001668* In :mod:`asyncio`, the explicit passing of a *loop* argument has been
1669 deprecated and will be removed in version 3.10 for the following:
1670 :func:`asyncio.sleep`, :func:`asyncio.gather`, :func:`asyncio.shield`,
1671 :func:`asyncio.wait_for`, :func:`asyncio.wait`, :func:`asyncio.as_completed`,
1672 :class:`asyncio.Task`, :class:`asyncio.Lock`, :class:`asyncio.Event`,
1673 :class:`asyncio.Condition`, :class:`asyncio.Semaphore`,
1674 :class:`asyncio.BoundedSemaphore`, :class:`asyncio.Queue`,
1675 :func:`asyncio.create_subprocess_exec`, and
1676 :func:`asyncio.create_subprocess_shell`.
1677
1678* The explicit passing of coroutine objects to :func:`asyncio.wait` has been
Kyle Stanley457306b2019-10-28 21:53:22 -04001679 deprecated and will be removed in version 3.11.
1680 (Contributed by Yury Selivanov in :issue:`34790`.)
Kyle Stanley3bbb6db2019-10-24 00:15:25 -04001681
Serhiy Storchakafec35c92018-10-27 08:00:41 +03001682* The following functions and methods are deprecated in the :mod:`gettext`
1683 module: :func:`~gettext.lgettext`, :func:`~gettext.ldgettext`,
1684 :func:`~gettext.lngettext` and :func:`~gettext.ldngettext`.
1685 They return encoded bytes, and it's possible that you will get unexpected
1686 Unicode-related exceptions if there are encoding problems with the
1687 translated strings. It's much better to use alternatives which return
1688 Unicode strings in Python 3. These functions have been broken for a long time.
1689
1690 Function :func:`~gettext.bind_textdomain_codeset`, methods
1691 :meth:`~gettext.NullTranslations.output_charset` and
1692 :meth:`~gettext.NullTranslations.set_output_charset`, and the *codeset*
1693 parameter of functions :func:`~gettext.translation` and
1694 :func:`~gettext.install` are also deprecated, since they are only used for
1695 for the ``l*gettext()`` functions.
Serhiy Storchakafec35c92018-10-27 08:00:41 +03001696 (Contributed by Serhiy Storchaka in :issue:`33710`.)
1697
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001698* The :meth:`~threading.Thread.isAlive()` method of :class:`threading.Thread`
1699 has been deprecated.
Dong-hee Na89669ff2019-01-17 21:14:45 +09001700 (Contributed by Dong-hee Na in :issue:`35283`.)
Ned Deily07a18922018-01-31 18:12:38 -05001701
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001702* Many builtin and extension functions that take integer arguments will
1703 now emit a deprecation warning for :class:`~decimal.Decimal`\ s,
1704 :class:`~fractions.Fraction`\ s and any other objects that can be converted
1705 to integers only with a loss (e.g. that have the :meth:`~object.__int__`
1706 method but do not have the :meth:`~object.__index__` method). In future
1707 version they will be errors.
1708 (Contributed by Serhiy Storchaka in :issue:`36048`.)
1709
Serhiy Storchaka42a139e2019-04-01 09:16:35 +03001710* Deprecated passing the following arguments as keyword arguments:
1711
1712 - *func* in :func:`functools.partialmethod`, :func:`weakref.finalize`,
1713 :meth:`profile.Profile.runcall`, :meth:`cProfile.Profile.runcall`,
1714 :meth:`bdb.Bdb.runcall`, :meth:`trace.Trace.runfunc` and
1715 :func:`curses.wrapper`.
Serhiy Storchaka2085bd02019-06-01 11:00:15 +03001716 - *function* in :meth:`unittest.TestCase.addCleanup`.
Serhiy Storchaka42a139e2019-04-01 09:16:35 +03001717 - *fn* in the :meth:`~concurrent.futures.Executor.submit` method of
1718 :class:`concurrent.futures.ThreadPoolExecutor` and
1719 :class:`concurrent.futures.ProcessPoolExecutor`.
1720 - *callback* in :meth:`contextlib.ExitStack.callback`,
1721 :meth:`contextlib.AsyncExitStack.callback` and
1722 :meth:`contextlib.AsyncExitStack.push_async_callback`.
1723 - *c* and *typeid* in the :meth:`~multiprocessing.managers.Server.create`
1724 method of :class:`multiprocessing.managers.Server` and
1725 :class:`multiprocessing.managers.SharedMemoryServer`.
1726 - *obj* in :func:`weakref.finalize`.
1727
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001728 In future releases of Python, they will be :ref:`positional-only
Serhiy Storchaka42a139e2019-04-01 09:16:35 +03001729 <positional-only_parameter>`.
1730 (Contributed by Serhiy Storchaka in :issue:`36492`.)
1731
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001732
Victor Stinner73104fa2018-11-29 09:58:20 +01001733API and Feature Removals
1734========================
1735
1736The following features and APIs have been removed from Python 3.8:
1737
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001738* Starting with Python 3.3, importing ABCs from :mod:`collections` was
1739 deprecated, and importing should be done from :mod:`collections.abc`. Being
1740 able to import from collections was marked for removal in 3.8, but has been
1741 delayed to 3.9. (See :issue:`36952`.)
1742
Victor Stinnerd7538dd2018-12-14 13:37:26 +01001743* The :mod:`macpath` module, deprecated in Python 3.7, has been removed.
1744 (Contributed by Victor Stinner in :issue:`35471`.)
1745
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001746* The function :func:`platform.popen` has been removed, after having been
1747 deprecated since Python 3.3: use :func:`os.popen` instead.
Victor Stinner01ae8972019-06-03 16:28:01 +02001748 (Contributed by Victor Stinner in :issue:`35345`.)
Ned Deily07a18922018-01-31 18:12:38 -05001749
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001750* The function :func:`time.clock` has been removed, after having been
1751 deprecated since Python 3.3: use :func:`time.perf_counter` or
1752 :func:`time.process_time` instead, depending
1753 on your requirements, to have well-defined behavior.
Victor Stinner01ae8972019-06-03 16:28:01 +02001754 (Contributed by Matthias Bussonnier in :issue:`36895`.)
Matthias Bussonnierb6a09ae2019-05-13 12:23:07 -07001755
Brett Cannona8c34242018-04-20 14:15:40 -07001756* The ``pyvenv`` script has been removed in favor of ``python3.8 -m venv``
1757 to help eliminate confusion as to what Python interpreter the ``pyvenv``
1758 script is tied to. (Contributed by Brett Cannon in :issue:`25427`.)
Ned Deily07a18922018-01-31 18:12:38 -05001759
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001760* ``parse_qs``, ``parse_qsl``, and ``escape`` are removed from the :mod:`cgi`
1761 module. They are deprecated in Python 3.2 or older. They should be imported
Simon Willison1abf5432019-09-11 09:25:26 -05001762 from the ``urllib.parse`` and ``html`` modules instead.
INADA Naoki698865d2018-06-19 17:28:50 +09001763
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001764* ``filemode`` function is removed from the :mod:`tarfile` module.
INADA Naoki461a1c42018-06-28 17:10:36 +09001765 It is not documented and deprecated since Python 3.3.
INADA Naoki698865d2018-06-19 17:28:50 +09001766
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001767* The :class:`~xml.etree.ElementTree.XMLParser` constructor no longer accepts
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001768 the *html* argument. It never had an effect and was deprecated in Python 3.4.
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001769 All other parameters are now :ref:`keyword-only <keyword-only_parameter>`.
1770 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1771
1772* Removed the ``doctype()`` method of :class:`~xml.etree.ElementTree.XMLParser`.
1773 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1774
Inada Naoki6a16b182019-03-18 15:44:11 +09001775* "unicode_internal" codec is removed.
1776 (Contributed by Inada Naoki in :issue:`36297`.)
1777
Aviv Palivodae6576242019-05-09 21:05:45 +03001778* The ``Cache`` and ``Statement`` objects of the :mod:`sqlite3` module are not
1779 exposed to the user.
1780 (Contributed by Aviv Palivoda in :issue:`30262`.)
1781
Matthias Bussonnier1a3faf92019-05-20 13:44:11 -07001782* The ``bufsize`` keyword argument of :func:`fileinput.input` and
1783 :func:`fileinput.FileInput` which was ignored and deprecated since Python 3.6
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001784 has been removed. :issue:`36952` (Contributed by Matthias Bussonnier.)
Matthias Bussonnier1a3faf92019-05-20 13:44:11 -07001785
Matthias Bussonnier382034b2019-05-28 10:30:35 -07001786* The functions :func:`sys.set_coroutine_wrapper` and
1787 :func:`sys.get_coroutine_wrapper` deprecated in Python 3.7 have been removed;
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001788 :issue:`36933` (Contributed by Matthias Bussonnier.)
Matthias Bussonnier3880f262019-05-28 00:10:59 -07001789
Ned Deily07a18922018-01-31 18:12:38 -05001790
1791Porting to Python 3.8
1792=====================
1793
1794This section lists previously described changes and other bugfixes
1795that may require changes to your code.
1796
1797
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001798Changes in Python behavior
1799--------------------------
1800
1801* Yield expressions (both ``yield`` and ``yield from`` clauses) are now disallowed
1802 in comprehensions and generator expressions (aside from the iterable expression
Serhiy Storchaka2b57c432018-12-19 08:09:46 +02001803 in the leftmost :keyword:`!for` clause).
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001804 (Contributed by Serhiy Storchaka in :issue:`10544`.)
1805
Serhiy Storchaka3bcbedc2019-01-18 07:47:48 +02001806* The compiler now produces a :exc:`SyntaxWarning` when identity checks
1807 (``is`` and ``is not``) are used with certain types of literals
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001808 (e.g. strings, numbers). These can often work by accident in CPython,
Serhiy Storchaka3bcbedc2019-01-18 07:47:48 +02001809 but are not guaranteed by the language spec. The warning advises users
1810 to use equality tests (``==`` and ``!=``) instead.
1811 (Contributed by Serhiy Storchaka in :issue:`34850`.)
1812
Serhiy Storchaka7a0630c2019-04-08 14:34:04 +03001813* The CPython interpreter can swallow exceptions in some circumstances.
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001814 In Python 3.8 this happens in fewer cases. In particular, exceptions
Serhiy Storchaka7a0630c2019-04-08 14:34:04 +03001815 raised when getting the attribute from the type dictionary are no longer
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001816 ignored. (Contributed by Serhiy Storchaka in :issue:`35459`.)
Serhiy Storchaka7a0630c2019-04-08 14:34:04 +03001817
Serhiy Storchaka96aeaec2019-05-06 22:29:40 +03001818* Removed ``__str__`` implementations from builtin types :class:`bool`,
1819 :class:`int`, :class:`float`, :class:`complex` and few classes from
1820 the standard library. They now inherit ``__str__()`` from :class:`object`.
1821 As result, defining the ``__repr__()`` method in the subclass of these
barioddd6117c2019-09-27 20:01:33 +02001822 classes will affect their string representation.
Serhiy Storchaka96aeaec2019-05-06 22:29:40 +03001823 (Contributed by Serhiy Storchaka in :issue:`36793`.)
1824
Michael Felt9d949f72019-04-12 16:15:32 +02001825* On AIX, :attr:`sys.platform` doesn't contain the major version anymore.
1826 It is always ``'aix'``, instead of ``'aix3'`` .. ``'aix7'``. Since
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001827 older Python versions include the version number, so it is recommended to
1828 always use ``sys.platform.startswith('aix')``.
Michael Felt9d949f72019-04-12 16:15:32 +02001829 (Contributed by M. Felt in :issue:`36588`.)
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001830
Joannah Nanjekyef781d202019-04-29 04:38:45 -04001831* :c:func:`PyEval_AcquireLock` and :c:func:`PyEval_AcquireThread` now
1832 terminate the current thread if called while the interpreter is
1833 finalizing, making them consistent with :c:func:`PyEval_RestoreThread`,
1834 :c:func:`Py_END_ALLOW_THREADS`, and :c:func:`PyGILState_Ensure`. If this
Raymond Hettingera3291532019-10-13 23:32:03 -07001835 behavior is not desired, guard the call by checking :c:func:`_Py_IsFinalizing`
Joannah Nanjekyef781d202019-04-29 04:38:45 -04001836 or :c:func:`sys.is_finalizing`.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001837 (Contributed by Joannah Nanjekye in :issue:`36475`.)
1838
Joannah Nanjekyef781d202019-04-29 04:38:45 -04001839
Serhiy Storchaka97f1ca12018-02-01 18:49:21 +02001840Changes in the Python API
1841-------------------------
1842
Victor Stinner689830e2019-06-26 17:31:12 +02001843* The :func:`os.getcwdb` function now uses the UTF-8 encoding on Windows,
1844 rather than the ANSI code page: see :pep:`529` for the rationale. The
1845 function is no longer deprecated on Windows.
1846 (Contributed by Victor Stinner in :issue:`37412`.)
1847
Victor Stinnerd7befad2019-04-25 14:30:16 +02001848* :class:`subprocess.Popen` can now use :func:`os.posix_spawn` in some cases
1849 for better performance. On Windows Subsystem for Linux and QEMU User
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001850 Emulation, the :class:`Popen` constructor using :func:`os.posix_spawn` no longer raises an
1851 exception on errors like "missing program". Instead the child process fails with a
Victor Stinnerd7befad2019-04-25 14:30:16 +02001852 non-zero :attr:`~Popen.returncode`.
Victor Stinner01ae8972019-06-03 16:28:01 +02001853 (Contributed by Joannah Nanjekye and Victor Stinner in :issue:`35537`.)
Victor Stinnerd7befad2019-04-25 14:30:16 +02001854
Christian Heimes98d90f72019-08-27 23:36:56 +02001855* The *preexec_fn* argument of * :class:`subprocess.Popen` is no longer
1856 compatible with subinterpreters. The use of the parameter in a
1857 subinterpreter now raises :exc:`RuntimeError`.
1858 (Contributed by Eric Snow in :issue:`34651`, modified by Christian Heimes
1859 in :issue:`37951`.)
1860
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001861* The :meth:`imap.IMAP4.logout` method no longer silently ignores arbitrary
Victor Stinner74125a62019-04-15 18:23:20 +02001862 exceptions.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001863 (Contributed by Victor Stinner in :issue:`36348`.)
Victor Stinner74125a62019-04-15 18:23:20 +02001864
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001865* The function :func:`platform.popen` has been removed, after having been deprecated since
Victor Stinner73104fa2018-11-29 09:58:20 +01001866 Python 3.3: use :func:`os.popen` instead.
Victor Stinner01ae8972019-06-03 16:28:01 +02001867 (Contributed by Victor Stinner in :issue:`35345`.)
Victor Stinner73104fa2018-11-29 09:58:20 +01001868
Raymond Hettingerfc06a192019-03-12 00:43:27 -07001869* The :func:`statistics.mode` function no longer raises an exception
1870 when given multimodal data. Instead, it returns the first mode
1871 encountered in the input data. (Contributed by Raymond Hettinger
1872 in :issue:`35892`.)
1873
Serhiy Storchaka97f1ca12018-02-01 18:49:21 +02001874* The :meth:`~tkinter.ttk.Treeview.selection` method of the
1875 :class:`tkinter.ttk.Treeview` class no longer takes arguments. Using it with
1876 arguments for changing the selection was deprecated in Python 3.6. Use
1877 specialized methods like :meth:`~tkinter.ttk.Treeview.selection_set` for
1878 changing the selection. (Contributed by Serhiy Storchaka in :issue:`31508`.)
Serhiy Storchaka6c85efa52018-02-05 22:47:31 +02001879
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001880* The :meth:`writexml`, :meth:`toxml` and :meth:`toprettyxml` methods of
1881 :mod:`xml.dom.minidom`, and the :meth:`write` method of :mod:`xml.etree`,
1882 now preserve the attribute order specified by the user.
Diego Rojas06e1e682019-03-16 18:44:56 -05001883 (Contributed by Diego Rojas and Raymond Hettinger in :issue:`34160`.)
1884
Serhiy Storchaka6c85efa52018-02-05 22:47:31 +02001885* A :mod:`dbm.dumb` database opened with flags ``'r'`` is now read-only.
1886 :func:`dbm.dumb.open` with flags ``'r'`` and ``'w'`` no longer creates
1887 a database if it does not exist.
1888 (Contributed by Serhiy Storchaka in :issue:`32749`.)
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001889
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001890* The ``doctype()`` method defined in a subclass of
1891 :class:`~xml.etree.ElementTree.XMLParser` will no longer be called and will
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001892 emit a :exc:`RuntimeWarning` instead of a :exc:`DeprecationWarning`.
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001893 Define the :meth:`doctype() <xml.etree.ElementTree.TreeBuilder.doctype>`
1894 method on a target for handling an XML doctype declaration.
1895 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1896
Serhiy Storchakaf5e7b192018-05-20 08:48:12 +03001897* A :exc:`RuntimeError` is now raised when the custom metaclass doesn't
1898 provide the ``__classcell__`` entry in the namespace passed to
1899 ``type.__new__``. A :exc:`DeprecationWarning` was emitted in Python
1900 3.6--3.7. (Contributed by Serhiy Storchaka in :issue:`23722`.)
1901
Scott Sandersoncebe80b2018-06-07 05:46:42 -04001902* The :class:`cProfile.Profile` class can now be used as a context
1903 manager. (Contributed by Scott Sanderson in :issue:`29235`.)
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001904
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07001905* :func:`shutil.copyfile`, :func:`shutil.copy`, :func:`shutil.copy2`,
1906 :func:`shutil.copytree` and :func:`shutil.move` use platform-specific
1907 "fast-copy" syscalls (see
1908 :ref:`shutil-platform-dependent-efficient-copy-operations` section).
1909
1910* :func:`shutil.copyfile` default buffer size on Windows was changed from
1911 16 KiB to 1 MiB.
1912
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -07001913* The ``PyGC_Head`` struct has changed completely. All code that touched the
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001914 struct member should be rewritten. (See :issue:`33597`.)
INADA Naokid5c875b2018-07-11 17:42:49 +09001915
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001916* The :c:type:`PyInterpreterState` struct has been moved into the "internal"
Eric Snowbe3b2952019-02-23 11:35:52 -07001917 header files (specifically Include/internal/pycore_pystate.h). An
1918 opaque ``PyInterpreterState`` is still available as part of the public
1919 API (and stable ABI). The docs indicate that none of the struct's
1920 fields are public, so we hope no one has been using them. However,
1921 if you do rely on one or more of those private fields and have no
1922 alternative then please open a BPO issue. We'll work on helping
1923 you adjust (possibly including adding accessor functions to the
1924 public API). (See :issue:`35886`.)
1925
Berker Peksage7d4b2f2018-08-22 21:21:05 +03001926* The :meth:`mmap.flush() <mmap.mmap.flush>` method now returns ``None`` on
1927 success and raises an exception on error under all platforms. Previously,
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001928 its behavior was platform-dependent: a nonzero value was returned on success;
Berker Peksage7d4b2f2018-08-22 21:21:05 +03001929 zero was returned on error under Windows. A zero value was returned on
1930 success; an exception was raised on error under Unix.
1931 (Contributed by Berker Peksag in :issue:`2122`.)
1932
Andrés Delfinoca682612018-11-07 14:29:14 -03001933* :mod:`xml.dom.minidom` and :mod:`xml.sax` modules no longer process
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001934 external entities by default.
1935 (Contributed by Christian Heimes in :issue:`17239`.)
INADA Naokid5c875b2018-07-11 17:42:49 +09001936
Xiang Zhang4fb0b8b2018-12-12 20:46:55 +08001937* Deleting a key from a read-only :mod:`dbm` database (:mod:`dbm.dumb`,
1938 :mod:`dbm.gnu` or :mod:`dbm.ndbm`) raises :attr:`error` (:exc:`dbm.dumb.error`,
1939 :exc:`dbm.gnu.error` or :exc:`dbm.ndbm.error`) instead of :exc:`KeyError`.
1940 (Contributed by Xiang Zhang in :issue:`33106`.)
1941
Serhiy Storchaka85a2eef2020-02-17 11:03:00 +02001942* Simplified AST for literals. All constants will be represented as
1943 :class:`ast.Constant` instances. Instantiating old classes ``Num``,
1944 ``Str``, ``Bytes``, ``NameConstant`` and ``Ellipsis`` will return
1945 an instance of ``Constant``.
1946 (Contributed by Serhiy Storchaka in :issue:`32892`.)
1947
Steve Dower8ef864d2019-03-12 15:15:26 -07001948* :func:`~os.path.expanduser` on Windows now prefers the :envvar:`USERPROFILE`
1949 environment variable and does not use :envvar:`HOME`, which is not normally
1950 set for regular user accounts.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001951 (Contributed by Anthony Sottile in :issue:`36264`.)
Steve Dower8ef864d2019-03-12 15:15:26 -07001952
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001953* The exception :class:`asyncio.CancelledError` now inherits from
Kyle Stanley3bbb6db2019-10-24 00:15:25 -04001954 :class:`BaseException` rather than :class:`Exception`.
1955 (Contributed by Yury Selivanov in :issue:`32528`.)
1956
1957* The function :func:`asyncio.wait_for` now correctly waits for cancellation
1958 when using an instance of :class:`asyncio.Task`. Previously, upon reaching
1959 *timeout*, it was cancelled and immediately returned.
1960 (Contributed by Elvis Pranskevichus in :issue:`32751`.)
1961
1962* The function :func:`asyncio.BaseTransport.get_extra_info` now returns a safe
1963 to use socket object when 'socket' is passed to the *name* parameter.
1964 (Contributed by Yury Selivanov in :issue:`37027`.)
1965
1966* :class:`asyncio.BufferedProtocol` has graduated to the stable API.
Phil Jonese634da22019-10-12 17:46:13 +00001967
Steve Dower2438cdf2019-03-29 16:37:16 -07001968.. _bpo-36085-whatsnew:
1969
1970* DLL dependencies for extension modules and DLLs loaded with :mod:`ctypes` on
1971 Windows are now resolved more securely. Only the system paths, the directory
1972 containing the DLL or PYD file, and directories added with
1973 :func:`~os.add_dll_directory` are searched for load-time dependencies.
1974 Specifically, :envvar:`PATH` and the current working directory are no longer
1975 used, and modifications to these will no longer have any effect on normal DLL
1976 resolution. If your application relies on these mechanisms, you should check
1977 for :func:`~os.add_dll_directory` and if it exists, use it to add your DLLs
Steve Dower79da3882019-03-30 20:58:17 -07001978 directory while loading your library. Note that Windows 7 users will need to
benedwards14794616f2019-10-28 17:53:51 +00001979 ensure that Windows Update KB2533623 has been installed (this is also verified
Steve Dower79da3882019-03-30 20:58:17 -07001980 by the installer).
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001981 (Contributed by Steve Dower in :issue:`36085`.)
Steve Dower2438cdf2019-03-29 16:37:16 -07001982
Pablo Galindof2cf1e32019-04-13 17:05:14 +01001983* The header files and functions related to pgen have been removed after its
1984 replacement by a pure Python implementation. (Contributed by Pablo Galindo
1985 in :issue:`36623`.)
1986
Pablo Galindo5d23e282019-05-12 22:45:52 +01001987* :class:`types.CodeType` has a new parameter in the second position of the
1988 constructor (*posonlyargcount*) to support positional-only arguments defined
Pablo Galindocd74e662019-06-01 18:08:04 +01001989 in :pep:`570`. The first argument (*argcount*) now represents the total
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001990 number of positional arguments (including positional-only arguments). The new
Pablo Galindocd74e662019-06-01 18:08:04 +01001991 ``replace()`` method of :class:`types.CodeType` can be used to make the code
1992 future-proof.
Pablo Galindo5d23e282019-05-12 22:45:52 +01001993
Xiang Zhang4fb0b8b2018-12-12 20:46:55 +08001994
Inada Naokid3c72a22019-03-23 21:04:40 +09001995Changes in the C API
1996--------------------
1997
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001998* The :c:type:`PyCompilerFlags` structure got a new *cf_feature_version*
Victor Stinner2c9b4982019-06-13 02:01:29 +02001999 field. It should be initialized to ``PY_MINOR_VERSION``. The field is ignored
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04002000 by default, and is used if and only if ``PyCF_ONLY_AST`` flag is set in
Victor Stinner2c9b4982019-06-13 02:01:29 +02002001 *cf_flags*.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03002002 (Contributed by Guido van Rossum in :issue:`35766`.)
Victor Stinner2c9b4982019-06-13 02:01:29 +02002003
Victor Stinnerd5d9e812019-05-13 12:35:37 +02002004* The :c:func:`PyEval_ReInitThreads` function has been removed from the C API.
2005 It should not be called explicitly: use :c:func:`PyOS_AfterFork_Child`
2006 instead.
2007 (Contributed by Victor Stinner in :issue:`36728`.)
2008
E. M. Brayc994c8f2019-05-24 17:33:47 +02002009* On Unix, C extensions are no longer linked to libpython except on Android
2010 and Cygwin. When Python is embedded, ``libpython`` must not be loaded with
xdegaye254b3092019-04-29 09:27:40 +02002011 ``RTLD_LOCAL``, but ``RTLD_GLOBAL`` instead. Previously, using
E. M. Brayc994c8f2019-05-24 17:33:47 +02002012 ``RTLD_LOCAL``, it was already not possible to load C extensions which
2013 were not linked to ``libpython``, like C extensions of the standard
2014 library built by the ``*shared*`` section of ``Modules/Setup``.
Victor Stinner01ae8972019-06-03 16:28:01 +02002015 (Contributed by Victor Stinner in :issue:`21536`.)
Victor Stinner8c3ecc62019-04-25 20:13:10 +02002016
Inada Naokid3c72a22019-03-23 21:04:40 +09002017* Use of ``#`` variants of formats in parsing or building value (e.g.
2018 :c:func:`PyArg_ParseTuple`, :c:func:`Py_BuildValue`, :c:func:`PyObject_CallFunction`,
2019 etc.) without ``PY_SSIZE_T_CLEAN`` defined raises ``DeprecationWarning`` now.
2020 It will be removed in 3.10 or 4.0. Read :ref:`arg-parsing` for detail.
2021 (Contributed by Inada Naoki in :issue:`36381`.)
2022
Eddie Elizondo364f0b02019-03-27 07:52:18 -04002023* Instances of heap-allocated types (such as those created with
2024 :c:func:`PyType_FromSpec`) hold a reference to their type object.
2025 Increasing the reference count of these type objects has been moved from
2026 :c:func:`PyType_GenericAlloc` to the more low-level functions,
2027 :c:func:`PyObject_Init` and :c:func:`PyObject_INIT`.
2028 This makes types created through :c:func:`PyType_FromSpec` behave like
2029 other classes in managed code.
2030
2031 Statically allocated types are not affected.
2032
2033 For the vast majority of cases, there should be no side effect.
2034 However, types that manually increase the reference count after allocating
2035 an instance (perhaps to work around the bug) may now become immortal.
2036 To avoid this, these classes need to call Py_DECREF on the type object
2037 during instance deallocation.
2038
2039 To correctly port these types into 3.8, please apply the following
2040 changes:
2041
2042 * Remove :c:macro:`Py_INCREF` on the type object after allocating an
2043 instance - if any.
2044 This may happen after calling :c:func:`PyObject_New`,
2045 :c:func:`PyObject_NewVar`, :c:func:`PyObject_GC_New`,
2046 :c:func:`PyObject_GC_NewVar`, or any other custom allocator that uses
2047 :c:func:`PyObject_Init` or :c:func:`PyObject_INIT`.
2048
Serhiy Storchaka298439c2019-10-14 16:10:40 +03002049 Example:
2050
2051 .. code-block:: c
Eddie Elizondo364f0b02019-03-27 07:52:18 -04002052
2053 static foo_struct *
2054 foo_new(PyObject *type) {
2055 foo_struct *foo = PyObject_GC_New(foo_struct, (PyTypeObject *) type);
2056 if (foo == NULL)
2057 return NULL;
2058 #if PY_VERSION_HEX < 0x03080000
2059 // Workaround for Python issue 35810; no longer necessary in Python 3.8
2060 PY_INCREF(type)
2061 #endif
2062 return foo;
2063 }
2064
2065 * Ensure that all custom ``tp_dealloc`` functions of heap-allocated types
2066 decrease the type's reference count.
2067
Serhiy Storchaka298439c2019-10-14 16:10:40 +03002068 Example:
2069
2070 .. code-block:: c
Eddie Elizondo364f0b02019-03-27 07:52:18 -04002071
2072 static void
2073 foo_dealloc(foo_struct *instance) {
2074 PyObject *type = Py_TYPE(instance);
2075 PyObject_GC_Del(instance);
2076 #if PY_VERSION_HEX >= 0x03080000
2077 // This was not needed before Python 3.8 (Python issue 35810)
2078 Py_DECREF(type);
2079 #endif
2080 }
2081
2082 (Contributed by Eddie Elizondo in :issue:`35810`.)
2083
Zackery Spytz3c8724f2019-05-28 09:16:33 -06002084* The :c:macro:`Py_DEPRECATED()` macro has been implemented for MSVC.
2085 The macro now must be placed before the symbol name.
2086
Serhiy Storchaka298439c2019-10-14 16:10:40 +03002087 Example:
2088
2089 .. code-block:: c
Zackery Spytz3c8724f2019-05-28 09:16:33 -06002090
2091 Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);
2092
2093 (Contributed by Zackery Spytz in :issue:`33407`.)
2094
Antoine Pitrouada319b2019-05-29 22:12:38 +02002095* The interpreter does not pretend to support binary compatibility of
Xtreak0d702272019-06-03 04:42:33 +05302096 extension types across feature releases, anymore. A :c:type:`PyTypeObject`
Antoine Pitrouada319b2019-05-29 22:12:38 +02002097 exported by a third-party extension module is supposed to have all the
2098 slots expected in the current Python version, including
2099 :c:member:`~PyTypeObject.tp_finalize` (:const:`Py_TPFLAGS_HAVE_FINALIZE`
2100 is not checked anymore before reading :c:member:`~PyTypeObject.tp_finalize`).
2101
2102 (Contributed by Antoine Pitrou in :issue:`32388`.)
2103
Pablo Galindo545a3b82019-05-31 19:33:41 +01002104* The :c:func:`PyCode_New` has a new parameter in the second position (*posonlyargcount*)
2105 to support :pep:`570`, indicating the number of positional-only arguments.
2106
Ivan Levkivskyi47c2de72019-06-19 01:17:47 +01002107* The functions :c:func:`PyNode_AddChild` and :c:func:`PyParser_AddToken` now accept
2108 two additional ``int`` arguments *end_lineno* and *end_col_offset*.
Eddie Elizondo364f0b02019-03-27 07:52:18 -04002109
Steve Dowerf5690922019-06-21 14:28:46 -07002110* The :file:`libpython38.a` file to allow MinGW tools to link directly against
2111 :file:`python38.dll` is no longer included in the regular Windows distribution.
2112 If you require this file, it may be generated with the ``gendef`` and
Serhiy Storchaka298439c2019-10-14 16:10:40 +03002113 ``dlltool`` tools, which are part of the MinGW binutils package:
2114
2115 .. code-block:: shell
Steve Dowerf5690922019-06-21 14:28:46 -07002116
Baljak2545fa82020-02-05 01:10:16 +01002117 gendef - python38.dll > tmp.def
Steve Dowerf5690922019-06-21 14:28:46 -07002118 dlltool --dllname python38.dll --def tmp.def --output-lib libpython38.a
2119
2120 The location of an installed :file:`pythonXY.dll` will depend on the
2121 installation options and the version and language of Windows. See
2122 :ref:`using-on-windows` for more information. The resulting library should be
2123 placed in the same directory as :file:`pythonXY.lib`, which is generally the
2124 :file:`libs` directory under your Python installation.
2125
Serhiy Storchaka298439c2019-10-14 16:10:40 +03002126 (Contributed by Steve Dower in :issue:`37351`.)
Steve Dowerf5690922019-06-21 14:28:46 -07002127
2128
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02002129CPython bytecode changes
2130------------------------
2131
2132* The interpreter loop has been simplified by moving the logic of unrolling
2133 the stack of blocks into the compiler. The compiler emits now explicit
Serhiy Storchaka3f819ca2018-10-31 02:26:06 +02002134 instructions for adjusting the stack of values and calling the
2135 cleaning-up code for :keyword:`break`, :keyword:`continue` and
2136 :keyword:`return`.
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02002137
2138 Removed opcodes :opcode:`BREAK_LOOP`, :opcode:`CONTINUE_LOOP`,
2139 :opcode:`SETUP_LOOP` and :opcode:`SETUP_EXCEPT`. Added new opcodes
2140 :opcode:`ROT_FOUR`, :opcode:`BEGIN_FINALLY`, :opcode:`CALL_FINALLY` and
2141 :opcode:`POP_FINALLY`. Changed the behavior of :opcode:`END_FINALLY`
2142 and :opcode:`WITH_CLEANUP_START`.
2143
2144 (Contributed by Mark Shannon, Antoine Pitrou and Serhiy Storchaka in
2145 :issue:`17611`.)
Serhiy Storchaka702f8f32018-03-23 14:34:35 +02002146
2147* Added new opcode :opcode:`END_ASYNC_FOR` for handling exceptions raised
2148 when awaiting a next item in an :keyword:`async for` loop.
2149 (Contributed by Serhiy Storchaka in :issue:`33041`.)
Raymond Hettingerf75d59e2019-02-02 22:54:56 -08002150
Pablo Galindob51b7132019-06-25 02:41:58 +01002151* The :opcode:`MAP_ADD` now expects the value as the first element in the
2152 stack and the key as the second element. This change was made so the key
2153 is always evaluated before the value in dictionary comprehensions, as
Pablo Galindode9b6062019-06-25 11:55:23 +01002154 proposed by :pep:`572`. (Contributed by Jörn Heissler in :issue:`35224`.)
Pablo Galindob51b7132019-06-25 02:41:58 +01002155
Raymond Hettingerf75d59e2019-02-02 22:54:56 -08002156
2157Demos and Tools
2158---------------
2159
Raymond Hettinger1cdadf42019-11-03 21:47:01 -08002160Added a benchmark script for timing various ways to access variables:
2161``Tools/scripts/var_access_benchmark.py``.
2162(Contributed by Raymond Hettinger in :issue:`35884`.)
2163
2164Here's a summary of performance improvements since Python 3.3:
2165
2166.. code-block:: none
2167
2168 Python version 3.3 3.4 3.5 3.6 3.7 3.8
2169 -------------- --- --- --- --- --- ---
2170
2171 Variable and attribute read access:
2172 read_local 4.0 7.1 7.1 5.4 5.1 3.9
2173 read_nonlocal 5.3 7.1 8.1 5.8 5.4 4.4
2174 read_global 13.3 15.5 19.0 14.3 13.6 7.6
2175 read_builtin 20.0 21.1 21.6 18.5 19.0 7.5
2176 read_classvar_from_class 20.5 25.6 26.5 20.7 19.5 18.4
2177 read_classvar_from_instance 18.5 22.8 23.5 18.8 17.1 16.4
2178 read_instancevar 26.8 32.4 33.1 28.0 26.3 25.4
2179 read_instancevar_slots 23.7 27.8 31.3 20.8 20.8 20.2
2180 read_namedtuple 68.5 73.8 57.5 45.0 46.8 18.4
2181 read_boundmethod 29.8 37.6 37.9 29.6 26.9 27.7
2182
2183 Variable and attribute write access:
2184 write_local 4.6 8.7 9.3 5.5 5.3 4.3
2185 write_nonlocal 7.3 10.5 11.1 5.6 5.5 4.7
2186 write_global 15.9 19.7 21.2 18.0 18.0 15.8
2187 write_classvar 81.9 92.9 96.0 104.6 102.1 39.2
2188 write_instancevar 36.4 44.6 45.8 40.0 38.9 35.5
2189 write_instancevar_slots 28.7 35.6 36.1 27.3 26.6 25.7
2190
2191 Data structure read access:
2192 read_list 19.2 24.2 24.5 20.8 20.8 19.0
2193 read_deque 19.9 24.7 25.5 20.2 20.6 19.8
2194 read_dict 19.7 24.3 25.7 22.3 23.0 21.0
2195 read_strdict 17.9 22.6 24.3 19.5 21.2 18.9
2196
2197 Data structure write access:
2198 write_list 21.2 27.1 28.5 22.5 21.6 20.0
2199 write_deque 23.8 28.7 30.1 22.7 21.8 23.5
2200 write_dict 25.9 31.4 33.3 29.3 29.2 24.7
2201 write_strdict 22.9 28.4 29.9 27.5 25.2 23.1
2202
2203 Stack (or queue) operations:
2204 list_append_pop 144.2 93.4 112.7 75.4 74.2 50.8
2205 deque_append_pop 30.4 43.5 57.0 49.4 49.2 42.5
2206 deque_append_popleft 30.8 43.7 57.3 49.7 49.7 42.8
2207
2208 Timing loop:
2209 loop_overhead 0.3 0.5 0.6 0.4 0.3 0.3
2210
2211 (Measured from the macOS 64-bit builds found at python.org)
Kyle Stanleyf501db22019-12-16 16:50:34 -05002212
2213Notable changes in Python 3.8.1
2214===============================
2215
2216Due to significant security concerns, the *reuse_address* parameter of
2217:meth:`asyncio.loop.create_datagram_endpoint` is no longer supported. This is
2218because of the behavior of the socket option ``SO_REUSEADDR`` in UDP. For more
2219details, see the documentation for ``loop.create_datagram_endpoint()``.
2220(Contributed by Kyle Stanley, Antoine Pitrou, and Yury Selivanov in
2221:issue:`37228`.)