blob: 8108fb7e14704a7749a91f4ce749dd615c7aa988 [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 -070050Prerelease users should be aware that this document is currently in
51draft form. It will be updated as Python 3.8 moves towards release, so
52it's worth checking back even after reading earlier versions. Some
53notable items not yet covered are:
Ned Deily07a18922018-01-31 18:12:38 -050054
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070055* :pep:`578` - Runtime audit hooks for potentially sensitive operations
56* ``python -m asyncio`` runs a natively async REPL
Ned Deily07a18922018-01-31 18:12:38 -050057
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070058.. testsetup::
Nick Coghlanb9438ce2019-06-09 19:07:42 +100059
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070060 from datetime import date
61 from math import cos, radians
Raymond Hettinger66a34d32019-08-12 15:55:18 -070062 from unicodedata import normalize
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070063 import re
64 import math
Nick Coghlanb9438ce2019-06-09 19:07:42 +100065
Ned Deily07a18922018-01-31 18:12:38 -050066
67Summary -- Release highlights
68=============================
69
70.. This section singles out the most important changes in Python 3.8.
71 Brevity is key.
72
73
74.. PEP-sized items next.
75
76
77
78New Features
79============
80
Guido van Rossum09d434c2019-04-24 11:30:17 -070081Assignment expressions
82----------------------
83
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070084There is new syntax ``:=`` that assigns values to variables as part of a larger
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -040085expression. It is affectionately known as "the walrus operator" due to
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070086its resemblance to `the eyes and tusks of a walrus
87<https://en.wikipedia.org/wiki/Walrus#/media/File:Pacific_Walrus_-_Bull_(8247646168).jpg>`_.
88
89In this example, the assignment expression helps avoid calling
90:func:`len` twice::
Guido van Rossum09d434c2019-04-24 11:30:17 -070091
92 if (n := len(a)) > 10:
93 print(f"List is too long ({n} elements, expected <= 10)")
94
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070095A similar benefit arises during regular expression matching where
96match objects are needed twice, once to test whether a match
97occurred and another to extract a subgroup::
98
99 discount = 0.0
100 if (mo := re.search(r'(\d+)% discount', advertisement)):
101 discount = float(mo.group(1)) / 100.0
102
103The operator is also useful with while-loops that compute
104a value to test loop termination and then need that same
105value again in the body of the loop::
106
107 # Loop over fixed length blocks
108 while (block := f.read(256)) != '':
109 process(block)
110
111Another motivating use case arises in list comprehensions where
112a value computed in a filtering condition is also needed in
113the expression body::
114
115 [clean_name.title() for name in names
116 if (clean_name := normalize('NFC', name)) in allowed_names]
117
118Try to limit use of the walrus operator to clean cases that reduce
119complexity and improve readability.
120
Guido van Rossum09d434c2019-04-24 11:30:17 -0700121See :pep:`572` for a full description.
122
123(Contributed by Emily Morehouse in :issue:`35224`.)
124
Guido van Rossum09d434c2019-04-24 11:30:17 -0700125
Guido van Rossum843bf422019-04-29 05:49:30 -0700126Positional-only parameters
127--------------------------
128
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700129There is a new function parameter syntax ``/`` to indicate that some
130function parameters must be specified positionally and cannot be used as
131keyword arguments. This is the same notation shown by ``help()`` for C
132functions annotated with Larry Hastings' `Argument Clinic
133<https://docs.python.org/3/howto/clinic.html>`_ tool.
134
135In the following example, parameters *a* and *b* are positional-only,
136while *c* or *d* can be positional or keyword, and *e* or *f* are
137required to be keywords::
138
139 def f(a, b, /, c, d, *, e, f):
140 print(a, b, c, d, e, f)
141
142The following is a valid call::
143
144 f(10, 20, 30, d=40, e=50, f=60)
145
146However, these are invalid calls::
147
148 f(10, b=20, c=30, d=40, e=50, f=60) # b cannot be a keyword argument
149 f(10, 20, 30, 40, 50, f=60) # e must be a keyword argument
150
151One use case for this notation is that it allows pure Python functions
152to fully emulate behaviors of existing C coded functions. For example,
153the built-in :func:`pow` function does not accept keyword arguments::
Guido van Rossum843bf422019-04-29 05:49:30 -0700154
155 def pow(x, y, z=None, /):
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700156 "Emulate the built in pow() function"
157 r = x ** y
158 return r if z is None else r%z
Guido van Rossum843bf422019-04-29 05:49:30 -0700159
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700160Another use case is to preclude keyword arguments when the parameter
161name is not helpful. For example, the builtin :func:`len` function has
162the signature ``len(obj, /)``. This precludes awkward calls such as::
163
164 len(obj='hello') # The "obj" keyword argument impairs readability
165
166A further benefit of marking a parameter as positional-only is that it
167allows the parameter name to be changed in the future without risk of
168breaking client code. For example, in the :mod:`statistics` module, the
169parameter name *dist* may be changed in the future. This was made
170possible with the following function specification::
171
172 def quantiles(dist, /, *, n=4, method='exclusive')
173 ...
174
175Since the parameters to the left of ``/`` are not exposed as possible
176keywords, the parameters names remain available for use in ``**kwargs``::
177
178 >>> def f(a, b, /, **kwargs):
179 ... print(a, b, kwargs)
180 ...
181 >>> f(10, 20, a=1, b=2, c=3) # a and b are used in two ways
182 10 20 {'a': 1, 'b': 2, 'c': 3}
183
184This greatly simplifies the implementation of functions and methods
185that need to accept arbitrary keyword arguments. For example, here
Hugo van Kemenade547c60c2019-10-12 20:53:36 +0300186is an excerpt from code in the :mod:`collections` module::
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700187
188 class Counter(dict):
189
190 def __init__(self, iterable=None, /, **kwds):
191 # Note "iterable" is a possible keyword argument
Guido van Rossum843bf422019-04-29 05:49:30 -0700192
193See :pep:`570` for a full description.
194
195(Contributed by Pablo Galindo in :issue:`36540`.)
196
197.. TODO: Pablo will sprint on docs at PyCon US 2019.
198
199
Nick Coghlan16eb3bc2018-06-20 21:25:01 +1000200Parallel filesystem cache for compiled bytecode files
201-----------------------------------------------------
202
203The new :envvar:`PYTHONPYCACHEPREFIX` setting (also available as
204:option:`-X` ``pycache_prefix``) configures the implicit bytecode
205cache to use a separate parallel filesystem tree, rather than
206the default ``__pycache__`` subdirectories within each source
207directory.
208
209The location of the cache is reported in :data:`sys.pycache_prefix`
210(:const:`None` indicates the default location in ``__pycache__``
211subdirectories).
212
213(Contributed by Carl Meyer in :issue:`33499`.)
Ned Deily07a18922018-01-31 18:12:38 -0500214
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300215
Victor Stinner40460692019-04-26 17:56:44 +0200216Debug build uses the same ABI as release build
217-----------------------------------------------
218
Hugo van Kemenade547c60c2019-10-12 20:53:36 +0300219Python now uses the same ABI whether it's built in release or debug mode. On
Paul Ganssle5c403b22019-04-27 14:14:35 -0400220Unix, when Python is built in debug mode, it is now possible to load C
221extensions built in release mode and C extensions built using the stable ABI.
Victor Stinner40460692019-04-26 17:56:44 +0200222
Paul Ganssle5c403b22019-04-27 14:14:35 -0400223Release builds and debug builds are now ABI compatible: defining the
224``Py_DEBUG`` macro no longer implies the ``Py_TRACE_REFS`` macro, which
225introduces the only ABI incompatibility. The ``Py_TRACE_REFS`` macro, which
226adds the :func:`sys.getobjects` function and the :envvar:`PYTHONDUMPREFS`
227environment variable, can be set using the new ``./configure --with-trace-refs``
228build option.
Victor Stinner40460692019-04-26 17:56:44 +0200229(Contributed by Victor Stinner in :issue:`36465`.)
230
E. M. Brayc994c8f2019-05-24 17:33:47 +0200231On Unix, C extensions are no longer linked to libpython except on Android
232and Cygwin.
Victor Stinner4ebcd7e2019-05-11 04:10:03 +0200233It is now possible
Paul Ganssle5c403b22019-04-27 14:14:35 -0400234for a statically linked Python to load a C extension built using a shared
235library Python.
Victor Stinner40460692019-04-26 17:56:44 +0200236(Contributed by Victor Stinner in :issue:`21536`.)
237
238On Unix, when Python is built in debug mode, import now also looks for C
239extensions compiled in release mode and for C extensions compiled with the
240stable ABI.
241(Contributed by Victor Stinner in :issue:`36722`.)
242
Victor Stinner0a8e5722019-05-23 03:30:23 +0200243To embed Python into an application, a new ``--embed`` option must be passed to
244``python3-config --libs --embed`` to get ``-lpython3.8`` (link the application
245to libpython). To support both 3.8 and older, try ``python3-config --libs
246--embed`` first and fallback to ``python3-config --libs`` (without ``--embed``)
247if the previous command fails.
248
249Add a pkg-config ``python-3.8-embed`` module to embed Python into an
250application: ``pkg-config python-3.8-embed --libs`` includes ``-lpython3.8``.
251To support both 3.8 and older, try ``pkg-config python-X.Y-embed --libs`` first
252and fallback to ``pkg-config python-X.Y --libs`` (without ``--embed``) if the
253previous command fails (replace ``X.Y`` with the Python version).
254
255On the other hand, ``pkg-config python3.8 --libs`` no longer contains
256``-lpython3.8``. C extensions must not be linked to libpython (except on
E. M. Brayc994c8f2019-05-24 17:33:47 +0200257Android and Cygwin, whose cases are handled by the script);
258this change is backward incompatible on purpose.
Victor Stinner0a8e5722019-05-23 03:30:23 +0200259(Contributed by Victor Stinner in :issue:`36721`.)
260
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400261
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700262f-strings support ``=`` for self-documenting expressions and debugging
263----------------------------------------------------------------------
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400264
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700265Added an ``=`` specifier to :term:`f-string`\s. An f-string such as
266``f'{expr=}'`` will expand to the text of the expression, an equal sign,
267then the representation of the evaluated expression. For example:
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400268
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700269 >>> user = 'eric_idle'
270 >>> member_since = date(1975, 7, 31)
271 >>> f'{user=} {member_since=}'
272 "user='eric_idle' member_since=datetime.date(1975, 7, 31)"
273
274The usual :ref:`f-string format specifiers <f-strings>` allow more
275control over how the result of the expression is displayed::
276
277 >>> delta = date.today() - member_since
278 >>> f'{user=!s} {delta.days=:,d}'
279 'user=eric_idle delta.days=16,075'
280
281The ``=`` specifier will display the whole expression so that
282calculations can be shown::
283
284 >>> print(f'{theta=} {cos(radians(theta))=:.3f}')
285 theta=30 cos(radians(theta))=0.866
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400286
287(Contributed by Eric V. Smith and Larry Hastings in :issue:`36817`.)
288
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300289
Victor Stinner331a6a52019-05-27 16:39:22 +0200290PEP 587: Python Initialization Configuration
291--------------------------------------------
292
293The :pep:`587` adds a new C API to configure the Python Initialization
294providing finer control on the whole configuration and better error reporting.
295
296New structures:
297
298* :c:type:`PyConfig`
299* :c:type:`PyPreConfig`
300* :c:type:`PyStatus`
301* :c:type:`PyWideStringList`
302
303New functions:
304
305* :c:func:`PyConfig_Clear`
306* :c:func:`PyConfig_InitIsolatedConfig`
307* :c:func:`PyConfig_InitPythonConfig`
308* :c:func:`PyConfig_Read`
309* :c:func:`PyConfig_SetArgv`
310* :c:func:`PyConfig_SetBytesArgv`
311* :c:func:`PyConfig_SetBytesString`
312* :c:func:`PyConfig_SetString`
313* :c:func:`PyPreConfig_InitIsolatedConfig`
314* :c:func:`PyPreConfig_InitPythonConfig`
315* :c:func:`PyStatus_Error`
316* :c:func:`PyStatus_Exception`
317* :c:func:`PyStatus_Exit`
318* :c:func:`PyStatus_IsError`
319* :c:func:`PyStatus_IsExit`
320* :c:func:`PyStatus_NoMemory`
321* :c:func:`PyStatus_Ok`
322* :c:func:`PyWideStringList_Append`
323* :c:func:`PyWideStringList_Insert`
324* :c:func:`Py_BytesMain`
325* :c:func:`Py_ExitStatusException`
326* :c:func:`Py_InitializeFromConfig`
327* :c:func:`Py_PreInitialize`
328* :c:func:`Py_PreInitializeFromArgs`
329* :c:func:`Py_PreInitializeFromBytesArgs`
330* :c:func:`Py_RunMain`
331
332This PEP also adds ``_PyRuntimeState.preconfig`` (:c:type:`PyPreConfig` type)
333and ``PyInterpreterState.config`` (:c:type:`PyConfig` type) fields to these
334internal structures. ``PyInterpreterState.config`` becomes the new
335reference configuration, replacing global configuration variables and
336other private variables.
337
338See :ref:`Python Initialization Configuration <init-config>` for the
339documentation.
340
341See :pep:`587` for a full description.
342
343(Contributed by Victor Stinner in :issue:`36763`.)
344
Ned Deily07a18922018-01-31 18:12:38 -0500345
Jeroen Demeyer9e3e06e2019-06-03 01:43:13 +0200346Vectorcall: a fast calling protocol for CPython
347-----------------------------------------------
348
349The "vectorcall" protocol is added to the Python/C API.
350It is meant to formalize existing optimizations which were already done
351for various classes.
352Any extension type implementing a callable can use this protocol.
353
354This is currently provisional,
355the aim is to make it fully public in Python 3.9.
356
357See :pep:`590` for a full description.
358
359(Contributed by Jeroen Demeyer and Mark Shannon in :issue:`36974`.)
360
361
Antoine Pitrouc879ff22019-06-09 14:47:15 +0200362Pickle protocol 5 with out-of-band data buffers
363-----------------------------------------------
364
365When :mod:`pickle` is used to transfer large data between Python processes
366in order to take advantage of multi-core or multi-machine processing,
367it is important to optimize the transfer by reducing memory copies, and
368possibly by applying custom techniques such as data-dependent compression.
369
370The :mod:`pickle` protocol 5 introduces support for out-of-band buffers
371where :pep:`3118`-compatible data can be transmitted separately from the
372main pickle stream, at the discretion of the communication layer.
373
374See :pep:`574` for a full description.
375
376(Contributed by Antoine Pitrou in :issue:`36785`.)
377
378
Ned Deily07a18922018-01-31 18:12:38 -0500379Other Language Changes
380======================
381
Serhiy Storchakafe2bbb12018-03-18 09:56:52 +0200382* A :keyword:`continue` statement was illegal in the :keyword:`finally` clause
383 due to a problem with the implementation. In Python 3.8 this restriction
384 was lifted.
385 (Contributed by Serhiy Storchaka in :issue:`32489`.)
386
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700387* The :class:`bool`, :class:`int`, and :class:`fractions.Fraction` types
388 now have an :meth:`~int.as_integer_ratio` method like that found in
389 :class:`float` and :class:`decimal.Decimal`. This minor API extension
390 makes it possible to write ``numerator, denominator =
391 x.as_integer_ratio()`` and have it work across multiple numeric types.
392 (Contributed by Lisa Roach in :issue:`33073` and Raymond Hettinger in
393 :issue:`37819`.)
Lisa Roach5ac70432018-09-13 23:56:23 -0700394
Serhiy Storchakabdbad712019-06-02 00:05:48 +0300395* Constructors of :class:`int`, :class:`float` and :class:`complex` will now
396 use the :meth:`~object.__index__` special method, if available and the
397 corresponding method :meth:`~object.__int__`, :meth:`~object.__float__`
398 or :meth:`~object.__complex__` is not available.
399 (Contributed by Serhiy Storchaka in :issue:`20092`.)
400
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700401* Added support of ``\N{name}`` escapes in :mod:`regular expressions <re>`::
402
403 >>> notice = 'Copyright © 2019'
404 >>> copyright_year_pattern = re.compile(r'\N{copyright sign}\s*(\d{4})')
405 >>> int(copyright_year_pattern.search(notice).group(1))
406 2019
407
Serhiy Storchakaa445feb2018-02-10 00:08:17 +0200408 (Contributed by Jonathan Eunice and Serhiy Storchaka in :issue:`30688`.)
Ned Deily07a18922018-01-31 18:12:38 -0500409
Rémi Lapeyre6531bf62018-11-06 01:38:54 +0100410* Dict and dictviews are now iterable in reversed insertion order using
411 :func:`reversed`. (Contributed by Rémi Lapeyre in :issue:`33462`.)
412
Benjamin Petersonc9a71dd2018-09-12 17:14:39 -0700413* The syntax allowed for keyword names in function calls was further
414 restricted. In particular, ``f((keyword)=arg)`` is no longer allowed. It was
415 never intended to permit more than a bare name on the left-hand side of a
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300416 keyword argument assignment term.
417 (Contributed by Benjamin Peterson in :issue:`34641`.)
Ned Deily07a18922018-01-31 18:12:38 -0500418
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700419* Generalized iterable unpacking in :keyword:`yield` and
420 :keyword:`return` statements no longer requires enclosing parentheses.
421 This brings the *yield* and *return* syntax into better agreement with
422 normal assignment syntax::
423
424 >>> def parse(family):
425 lastname, *members = family.split()
426 return lastname.upper(), *members
427
428 >>> parse('simpsons homer marge bart lisa sally')
429 ('SIMPSONS', 'homer', 'marge', 'bart', 'lisa', 'sally')
430
jChapman8fabae32018-09-22 21:13:10 -0400431 (Contributed by David Cuthbert and Jordan Chapman in :issue:`32117`.)
432
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700433* When a comma is missed in code such as ``[(10, 20) (30, 40)]``, the
434 compiler displays a :exc:`SyntaxWarning` with a helpful suggestion.
435 This improves on just having a :exc:`TypeError` indicating that the
436 first tuple was not callable. (Contributed by Serhiy Storchaka in
437 :issue:`15248`.)
Serhiy Storchaka62e44812019-02-16 08:12:19 +0200438
Paul Ganssled9503c32019-02-08 11:02:00 -0500439* Arithmetic operations between subclasses of :class:`datetime.date` or
440 :class:`datetime.datetime` and :class:`datetime.timedelta` objects now return
441 an instance of the subclass, rather than the base class. This also affects
442 the return type of operations whose implementation (directly or indirectly)
443 uses :class:`datetime.timedelta` arithmetic, such as
444 :meth:`datetime.datetime.astimezone`.
445 (Contributed by Paul Ganssle in :issue:`32417`.)
446
Gregory P. Smith06babb22019-02-23 10:43:49 -0800447* When the Python interpreter is interrupted by Ctrl-C (SIGINT) and the
448 resulting :exc:`KeyboardInterrupt` exception is not caught, the Python process
449 now exits via a SIGINT signal or with the correct exit code such that the
450 calling process can detect that it died due to a Ctrl-C. Shells on POSIX
451 and Windows use this to properly terminate scripts in interactive sessions.
452 (Contributed by Google via Gregory P. Smith in :issue:`1054041`.)
453
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700454* Some advanced styles of programming require updating the
455 :class:`types.CodeType` object for an existing function. Since code
456 objects are immutable, a new code object needs to be created, one
457 that is modeled on the existing code object. With 19 parameters,
458 this was somewhat tedious. Now, the new ``replace()`` method makes
459 it possible to create a clone with a few altered parameters.
460
461 Here's an example that alters the :func:`statistics.mean` function to
462 prevent the *data* parameter from being used as a keyword argument::
463
464 >>> from statistics import mean
465 >>> mean(data=[10, 20, 90])
466 40
467 >>> mean.__code__ = mean.__code__.replace(co_posonlyargcount=1)
468 >>> mean(data=[10, 20, 90])
469 Traceback (most recent call last):
470 ...
471 TypeError: mean() got some positional-only arguments passed as keyword arguments: 'data'
472
Victor Stinnera9f05d62019-05-24 23:57:23 +0200473 (Contributed by Victor Stinner in :issue:`37032`.)
474
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700475* For integers, the three-argument form of the :func:`pow` function now
476 permits the exponent to be negative in the case where the base is
477 relatively prime to the modulus. It then computes a modular inverse to
478 the base when the exponent is ``-1``, and a suitable power of that
479 inverse for other negative exponents. For example, to compute the
480 `modular multiplicative inverse
481 <https://en.wikipedia.org/wiki/Modular_multiplicative_inverse>`_ of 38
482 modulo 137, write::
483
484 >>> pow(38, -1, 137)
485 119
486 >>> 119 * 38 % 137
487 1
488
489 Modular inverses arise in the solution of `linear Diophantine
490 equations <https://en.wikipedia.org/wiki/Diophantine_equation>`_.
491 For example, to find integer solutions for ``4258𝑥 + 147𝑦 = 369``,
492 first rewrite as ``4258𝑥 ≡ 369 (mod 147)`` then solve:
493
494 >>> x = 369 * pow(4258, -1, 147) % 147
495 >>> y = (4258 * x - 369) // -147
496 >>> 4258 * x + 147 * y
497 369
498
Mark Dickinsonc5299672019-06-02 10:24:06 +0100499 (Contributed by Mark Dickinson in :issue:`36027`.)
500
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700501* Dict comprehensions have been synced-up with dict literals so that the
502 key is computed first and the value second::
503
504 >>> # Dict comprehension
505 >>> cast = {input('role? '): input('actor? ') for i in range(2)}
506 role? King Arthur
507 actor? Chapman
508 role? Black Knight
509 actor? Cleese
510
511 >>> # Dict literal
512 >>> cast = {input('role? '): input('actor? ')}
513 role? Sir Robin
514 actor? Eric Idle
515
516 The guaranteed execution order is helpful with assignment expressions
517 because variables assigned in the key expression will be available in
518 the value expression::
519
520 >>> names = ['Martin von Löwis', 'Łukasz Langa', 'Walter Dörwald']
521 >>> {(n := normalize('NFC', name)).casefold() : n for name in names}
522 {'martin von löwis': 'Martin von Löwis',
523 'łukasz langa': 'Łukasz Langa',
524 'walter dörwald': 'Walter Dörwald'}
Pablo Galindob51b7132019-06-25 02:41:58 +0100525
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300526 (Contributed by Jörn Heissler in :issue:`35224`.)
527
Serhiy Storchaka65439122018-10-19 17:42:06 +0300528
Ned Deily07a18922018-01-31 18:12:38 -0500529New Modules
530===========
531
Barry Warsaw4867eaa2019-06-05 19:40:19 -0700532* The new :mod:`importlib.metadata` module provides (provisional) support for
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700533 reading metadata from third-party packages. For example, it can extract an
534 installed package's version number, list of entry points, and more::
535
536 >>> # Note following example requires that the popular "requests"
537 >>> # package has been installed.
538 >>>
539 >>> from importlib.metadata import version, requires, files
540 >>> version('requests')
541 '2.22.0'
542 >>> list(requires('requests'))
543 ['chardet (<3.1.0,>=3.0.2)']
544 >>> list(files('requests'))[:5]
545 [PackagePath('requests-2.22.0.dist-info/INSTALLER'),
546 PackagePath('requests-2.22.0.dist-info/LICENSE'),
547 PackagePath('requests-2.22.0.dist-info/METADATA'),
548 PackagePath('requests-2.22.0.dist-info/RECORD'),
549 PackagePath('requests-2.22.0.dist-info/WHEEL')]
550
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300551 (Contributed by Barry Warsaw and Jason R. Coombs in :issue:`34632`.)
Ned Deily07a18922018-01-31 18:12:38 -0500552
553
554Improved Modules
555================
556
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700557ast
558---
559
560AST nodes now have ``end_lineno`` and ``end_col_offset`` attributes,
561which give the precise location of the end of the node. (This only
562applies to nodes that have ``lineno`` and ``col_offset`` attributes.)
563
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300564New function :func:`ast.get_source_segment` returns the source code
565for a specific AST node.
566
567(Contributed by Ivan Levkivskyi in :issue:`33416`.)
568
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700569The :func:`ast.parse` function has some new flags:
570
571* ``type_comments=True`` causes it to return the text of :pep:`484` and
572 :pep:`526` type comments associated with certain AST nodes;
573
574* ``mode='func_type'`` can be used to parse :pep:`484` "signature type
575 comments" (returned for function definition AST nodes);
576
Guido van Rossum10b55c12019-06-11 17:23:12 -0700577* ``feature_version=(3, N)`` allows specifying an earlier Python 3
Hugo van Kemenade547c60c2019-10-12 20:53:36 +0300578 version. (For example, ``feature_version=(3, 4)`` will treat
Guido van Rossum10b55c12019-06-11 17:23:12 -0700579 ``async`` and ``await`` as non-reserved words.)
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700580
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300581(Contributed by Guido van Rossum in :issue:`35766`.)
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700582
583
Victor Stinner6ea29c52018-09-25 08:27:08 -0700584asyncio
585-------
586
587On Windows, the default event loop is now :class:`~asyncio.ProactorEventLoop`.
Victor Stinner01ae8972019-06-03 16:28:01 +0200588(Contributed by Victor Stinner in :issue:`34687`.)
589
590:class:`~asyncio.ProactorEventLoop` now also supports UDP.
591(Contributed by Adam Meily and Andrew Svetlov in :issue:`29883`.)
592
593:class:`~asyncio.ProactorEventLoop` can now be interrupted by
594:exc:`KeyboardInterrupt` ("CTRL+C").
595(Contributed by Vladimir Matveev in :issue:`23057`.)
596
Victor Stinner6ea29c52018-09-25 08:27:08 -0700597
Matthias Bussonnier2ddbd212019-05-22 12:07:45 -0700598builtins
599--------
600
601The :func:`compile` built-in has been improved to accept the
602``ast.PyCF_ALLOW_TOP_LEVEL_AWAIT`` flag. With this new flag passed,
603:func:`compile` will allow top-level ``await``, ``async for`` and ``async with``
604constructs that are usually considered invalid syntax. Asynchronous code object
605marked with the ``CO_COROUTINE`` flag may then be returned.
Matthias Bussonnier2ddbd212019-05-22 12:07:45 -0700606(Contributed by Matthias Bussonnier in :issue:`34616`)
Terry Jan Reedyfdcb5ae2018-09-25 12:45:27 -0400607
Raymond Hettinger61a6db52019-10-13 21:31:12 -0700608
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700609collections
610-----------
611
612The :meth:`_asdict()` method for :func:`collections.namedtuple` now returns
Daniel Porteous05222912019-05-02 04:20:59 -0400613a :class:`dict` instead of a :class:`collections.OrderedDict`. This works because
614regular dicts have guaranteed ordering since Python 3.7. If the extra
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700615features of :class:`OrderedDict` are required, the suggested remediation is
616to cast the result to the desired type: ``OrderedDict(nt._asdict())``.
617(Contributed by Raymond Hettinger in :issue:`35864`.)
618
619
Raymond Hettinger61a6db52019-10-13 21:31:12 -0700620curses
621-------
622
623Added a new variable holding structured version information for the
624underlying ncurses library: :data:`~curses.ncurses_version`.
625(Contributed by Serhiy Storchaka in :issue:`31680`.)
626
627
Steve Dower2438cdf2019-03-29 16:37:16 -0700628ctypes
629------
630
631On Windows, :class:`~ctypes.CDLL` and subclasses now accept a *winmode* parameter
632to specify flags for the underlying ``LoadLibraryEx`` call. The default flags are
633set to only load DLL dependencies from trusted locations, including the path
634where the DLL is stored (if a full or partial path is used to load the initial
635DLL) and paths added by :func:`~os.add_dll_directory`.
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300636(Contributed by Steve Dower in :issue:`36085`.)
Steve Dower2438cdf2019-03-29 16:37:16 -0700637
638
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -0400639datetime
640--------
641
642Added new alternate constructors :meth:`datetime.date.fromisocalendar` and
643:meth:`datetime.datetime.fromisocalendar`, which construct :class:`date` and
644:class:`datetime` objects respectively from ISO year, week number, and weekday;
645these are the inverse of each class's ``isocalendar`` method.
646(Contributed by Paul Ganssle in :issue:`36004`.)
647
648
Raymond Hettingerb8218682019-05-26 11:27:35 -0700649functools
650---------
651
652:func:`functools.lru_cache` can now be used as a straight decorator rather
653than as a function returning a decorator. So both of these are now supported::
654
655 @lru_cache
656 def f(x):
657 ...
658
659 @lru_cache(maxsize=256)
660 def f(x):
661 ...
662
663(Contributed by Raymond Hettinger in :issue:`36772`.)
664
665
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -0400666gc
667--
Paul Ganssle88c09372019-04-29 09:22:03 -0400668
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -0400669:func:`~gc.get_objects` can now receive an optional *generation* parameter
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300670indicating a generation to get objects from.
671(Contributed by Pablo Galindo in :issue:`36016`.)
Paul Ganssle88c09372019-04-29 09:22:03 -0400672
673
Cheryl Sabella637a33b2018-11-07 09:12:20 -0500674gettext
675-------
676
677Added :func:`~gettext.pgettext` and its variants.
678(Contributed by Franz Glasner, Éric Araujo, and Cheryl Sabella in :issue:`2504`.)
679
Terry Jan Reedya72ca902019-07-31 01:03:53 -0400680
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -0400681gzip
682----
683
684Added the *mtime* parameter to :func:`gzip.compress` for reproducible output.
685(Contributed by Guo Ci Teo in :issue:`34898`.)
686
687A :exc:`~gzip.BadGzipFile` exception is now raised instead of :exc:`OSError`
688for certain types of invalid or corrupt gzip files.
689(Contributed by Filip Gruszczyński, Michele Orrù, and Zackery Spytz in
690:issue:`6584`.)
691
692
Terry Jan Reedya72ca902019-07-31 01:03:53 -0400693idlelib and IDLE
694----------------
695
696Output over N lines (50 by default) is squeezed down to a button.
697N can be changed in the PyShell section of the General page of the
698Settings dialog. Fewer, but possibly extra long, lines can be squeezed by
699right clicking on the output. Squeezed output can be expanded in place
700by double-clicking the button or into the clipboard or a separate window
701by right-clicking the button. (Contributed by Tal Einat in :issue:`1529353`.)
702
703Add "Run Customized" to the Run menu to run a module with customized
704settings. Any command line arguments entered are added to sys.argv.
705They also re-appear in the box for the next customized run. One can also
706suppress the normal Shell main module restart. (Contributed by Cheryl
707Sabella, Terry Jan Reedy, and others in :issue:`5680` and :issue:`37627`.)
708
709Add optional line numbers for IDLE editor windows. Windows
710open without line numbers unless set otherwise in the General
711tab of the configuration dialog. Line numbers for an existing
712window are shown and hidden in the Options menu.
713(Contributed by Tal Einat and Saimadhav Heblikar in :issue:`17535`.)
714
715The changes above have been backported to 3.7 maintenance releases.
716
717
Raymond Hettingerd1e768a2019-03-25 13:01:13 -0700718inspect
719-------
720
721The :func:`inspect.getdoc` function can now find docstrings for ``__slots__``
722if that attribute is a :class:`dict` where the values are docstrings.
723This provides documentation options similar to what we already have
724for :func:`property`, :func:`classmethod`, and :func:`staticmethod`::
725
726 class AudioClip:
727 __slots__ = {'bit_rate': 'expressed in kilohertz to one decimal place',
728 'duration': 'in seconds, rounded up to an integer'}
729 def __init__(self, bit_rate, duration):
730 self.bit_rate = round(bit_rate / 1000.0, 1)
731 self.duration = ceil(duration)
Pablo Galindo175421b2019-02-23 03:02:06 +0000732
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300733(Contributed by Raymond Hettinger in :issue:`36326`.)
734
Terry Jan Reedya72ca902019-07-31 01:03:53 -0400735
Victor Stinnerbc2aa812019-05-23 03:45:09 +0200736io
737--
738
739In development mode (:option:`-X` ``env``) and in debug build, the
740:class:`io.IOBase` finalizer now logs the exception if the ``close()`` method
741fails. The exception is ignored silently by default in release build.
742(Contributed by Victor Stinner in :issue:`18748`.)
743
744
HongWeipengf1944792018-11-07 18:09:32 +0800745json.tool
746---------
747
748Add option ``--json-lines`` to parse every input line as separate JSON object.
749(Contributed by Weipeng Hong in :issue:`31553`.)
750
Pablo Galindobc098512019-02-07 07:04:02 +0000751
752math
753----
754
Raymond Hettinger3ff59622019-02-16 11:00:42 -0800755Added new function :func:`math.dist` for computing Euclidean distance
756between two points. (Contributed by Raymond Hettinger in :issue:`33089`.)
757
758Expanded the :func:`math.hypot` function to handle multiple dimensions.
759Formerly, it only supported the 2-D case.
760(Contributed by Raymond Hettinger in :issue:`33089`.)
761
Pablo Galindobc098512019-02-07 07:04:02 +0000762Added new function, :func:`math.prod`, as analogous function to :func:`sum`
763that returns the product of a 'start' value (default: 1) times an iterable of
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700764numbers::
765
766 >>> prior = 0.8
767 >>> likelihoods = [0.625, 0.84, 0.30]
Ashwin Vishnu1a8de822019-09-09 14:42:27 +0200768 >>> math.prod(likelihoods, start=prior)
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700769 0.126
770
771(Contributed by Pablo Galindo in :issue:`35606`)
Pablo Galindobc098512019-02-07 07:04:02 +0000772
Mark Dickinson73934b92019-05-18 12:29:50 +0100773Added new function :func:`math.isqrt` for computing integer square roots.
774(Contributed by Mark Dickinson in :issue:`36887`.)
775
Mark Dickinsona0adffb2019-06-01 12:21:53 +0100776The function :func:`math.factorial` no longer accepts arguments that are not
777int-like. (Contributed by Pablo Galindo in :issue:`33083`.)
778
Zackery Spytz02db6962019-05-27 10:48:17 -0600779
780mmap
781----
782
783The :class:`mmap.mmap` class now has an :meth:`~mmap.mmap.madvise` method to
784access the ``madvise()`` system call.
785(Contributed by Zackery Spytz in :issue:`32941`.)
786
787
Victor Stinner17a55882019-05-28 16:02:50 +0200788multiprocessing
789---------------
790
791Added new :mod:`multiprocessing.shared_memory` module.
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300792(Contributed by Davin Potts in :issue:`35813`.)
Victor Stinner17a55882019-05-28 16:02:50 +0200793
794On macOS, the *spawn* start method is now used by default.
795(Contributed by Victor Stinner in :issue:`33725`.)
796
797
Steve Dower2438cdf2019-03-29 16:37:16 -0700798os
799--
800
801Added new function :func:`~os.add_dll_directory` on Windows for providing
802additional search paths for native dependencies when importing extension
803modules or loading DLLs using :mod:`ctypes`.
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300804(Contributed by Steve Dower in :issue:`36085`.)
Steve Dower2438cdf2019-03-29 16:37:16 -0700805
Zackery Spytz43fdbd22019-05-29 13:57:07 -0600806A new :func:`os.memfd_create` function was added to wrap the
807``memfd_create()`` syscall.
808(Contributed by Zackery Spytz and Christian Heimes in :issue:`26836`.)
809
Steve Dowerdf2d4a62019-08-21 15:27:33 -0700810On Windows, much of the manual logic for handling reparse points (including
811symlinks and directory junctions) has been delegated to the operating system.
812Specifically, :func:`os.stat` will now traverse anything supported by the
813operating system, while :func:`os.lstat` will only open reparse points that
814identify as "name surrogates" while others are opened as for :func:`os.stat`.
815In all cases, :attr:`stat_result.st_mode` will only have ``S_IFLNK`` set for
816symbolic links and not other kinds of reparse points. To identify other kinds
817of reparse point, check the new :attr:`stat_result.st_reparse_tag` attribute.
818
819On Windows, :func:`os.readlink` is now able to read directory junctions. Note
820that :func:`~os.path.islink` will return ``False`` for directory junctions,
821and so code that checks ``islink`` first will continue to treat junctions as
822directories, while code that handles errors from :func:`os.readlink` may now
823treat junctions as links.
824
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300825(Contributed by Steve Dower in :issue:`37834`.)
826
Pablo Galindobc098512019-02-07 07:04:02 +0000827
Serhiy Storchaka0185f342018-09-18 11:28:51 +0300828os.path
829-------
830
831:mod:`os.path` functions that return a boolean result like
832:func:`~os.path.exists`, :func:`~os.path.lexists`, :func:`~os.path.isdir`,
833:func:`~os.path.isfile`, :func:`~os.path.islink`, and :func:`~os.path.ismount`
834now return ``False`` instead of raising :exc:`ValueError` or its subclasses
835:exc:`UnicodeEncodeError` and :exc:`UnicodeDecodeError` for paths that contain
836characters or bytes unrepresentable at the OS level.
837(Contributed by Serhiy Storchaka in :issue:`33721`.)
838
Steve Dower8ef864d2019-03-12 15:15:26 -0700839:func:`~os.path.expanduser` on Windows now prefers the :envvar:`USERPROFILE`
840environment variable and does not use :envvar:`HOME`, which is not normally set
841for regular user accounts.
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300842(Contributed by Anthony Sottile in :issue:`36264`.)
Steve Dower8ef864d2019-03-12 15:15:26 -0700843
Steve Dowerdf2d4a62019-08-21 15:27:33 -0700844:func:`~os.path.isdir` on Windows no longer returns true for a link to a
845non-existent directory.
846
Steve Dower75e06492019-08-21 13:43:06 -0700847:func:`~os.path.realpath` on Windows now resolves reparse points, including
848symlinks and directory junctions.
849
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300850(Contributed by Steve Dower in :issue:`37834`.)
851
Serhiy Storchakab232df92018-10-30 13:22:42 +0200852
Serhiy Storchaka0185f342018-09-18 11:28:51 +0300853pathlib
854-------
855
856:mod:`pathlib.Path` methods that return a boolean result like
857:meth:`~pathlib.Path.exists()`, :meth:`~pathlib.Path.is_dir()`,
858:meth:`~pathlib.Path.is_file()`, :meth:`~pathlib.Path.is_mount()`,
859:meth:`~pathlib.Path.is_symlink()`, :meth:`~pathlib.Path.is_block_device()`,
860:meth:`~pathlib.Path.is_char_device()`, :meth:`~pathlib.Path.is_fifo()`,
861:meth:`~pathlib.Path.is_socket()` now return ``False`` instead of raising
862:exc:`ValueError` or its subclass :exc:`UnicodeEncodeError` for paths that
863contain characters unrepresentable at the OS level.
864(Contributed by Serhiy Storchaka in :issue:`33721`.)
865
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -0400866Added :meth:`pathlib.Path.link_to()` which creates a hard link pointing
867to a path.
868(Contributed by Joannah Nanjekye in :issue:`26978`)
869
jab9e00d9e2018-12-28 13:03:40 -0500870
Pierre Glaserec6c1bd2019-07-01 15:51:57 +0200871pickle
872------
873
874Reduction methods can now include a 6th item in the tuple they return. This
875item should specify a custom state-setting method that's called instead of the
876regular ``__setstate__`` method.
877(Contributed by Pierre Glaser and Olivier Grisel in :issue:`35900`)
878
879:mod:`pickle` extensions subclassing the C-optimized :class:`~pickle.Pickler`
880can now override the pickling logic of functions and classes by defining the
881special :meth:`~pickle.Pickler.reducer_override` method.
882(Contributed by Pierre Glaser and Olivier Grisel in :issue:`35900`)
883
884
Jon Janzenc981ad12019-05-15 22:14:38 +0200885plistlib
886--------
887
888Added new :class:`plistlib.UID` and enabled support for reading and writing
889NSKeyedArchiver-encoded binary plists.
890(Contributed by Jon Janzen in :issue:`26707`.)
891
892
Joannah Nanjekye2e33ecd2019-05-28 13:29:04 -0300893py_compile
894----------
895
896:func:`py_compile.compile` now supports silent mode.
897(Contributed by Joannah Nanjekye in :issue:`22640`.)
898
899
Bo Baylesca804952019-05-29 03:06:12 -0500900shlex
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300901-----
Bo Baylesca804952019-05-29 03:06:12 -0500902
903The new :func:`shlex.join` function acts as the inverse of :func:`shlex.split`.
904(Contributed by Bo Bayles in :issue:`32102`.)
Giampaolo Rodolaeb7e29f2019-04-09 00:34:02 +0200905
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300906
jab9e00d9e2018-12-28 13:03:40 -0500907shutil
908------
909
910:func:`shutil.copytree` now accepts a new ``dirs_exist_ok`` keyword argument.
911(Contributed by Josh Bronson in :issue:`20849`.)
912
CAM Gerlach89a89442019-04-06 23:47:49 -0500913:func:`shutil.make_archive` now defaults to the modern pax (POSIX.1-2001)
914format for new archives to improve portability and standards conformance,
915inherited from the corresponding change to the :mod:`tarfile` module.
916(Contributed by C.A.M. Gerlach in :issue:`30661`.)
917
Steve Dowerdf2d4a62019-08-21 15:27:33 -0700918:func:`shutil.rmtree` on Windows now removes directory junctions without
919recursively removing their contents first.
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300920(Contributed by Steve Dower in :issue:`37834`.)
Steve Dowerdf2d4a62019-08-21 15:27:33 -0700921
jab9e00d9e2018-12-28 13:03:40 -0500922
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -0400923socket
924------
925
926Added :meth:`~socket.create_server()` and :meth:`~socket.has_dualstack_ipv6()`
927convenience functions to automate the necessary tasks usually involved when
928creating a server socket, including accepting both IPv4 and IPv6 connections
929on the same socket. (Contributed by Giampaolo Rodolà in :issue:`17561`.)
930
931The :func:`socket.if_nameindex()`, :func:`socket.if_nametoindex()`, and
932:func:`socket.if_indextoname()` functions have been implemented on Windows.
933(Contributed by Zackery Spytz in :issue:`37007`.)
934
935
Christian Heimes9fb051f2018-09-23 08:32:31 +0200936ssl
937---
938
Raymond Hettinger61a6db52019-10-13 21:31:12 -0700939Added :attr:`ssl.SSLContext.post_handshake_auth` to enable and
Christian Heimes9fb051f2018-09-23 08:32:31 +0200940:meth:`ssl.SSLSocket.verify_client_post_handshake` to initiate TLS 1.3
941post-handshake authentication.
942(Contributed by Christian Heimes in :issue:`34670`.)
943
Raymond Hettinger47d99872019-02-21 15:06:29 -0800944
945statistics
946----------
947
948Added :func:`statistics.fmean` as a faster, floating point variant of
949:func:`statistics.mean()`. (Contributed by Raymond Hettinger and
950Steven D'Aprano in :issue:`35904`.)
951
Raymond Hettinger6463ba32019-04-07 09:20:03 -0700952Added :func:`statistics.geometric_mean()`
953(Contributed by Raymond Hettinger in :issue:`27181`.)
954
Raymond Hettingerfc06a192019-03-12 00:43:27 -0700955Added :func:`statistics.multimode` that returns a list of the most
956common values. (Contributed by Raymond Hettinger in :issue:`35892`.)
957
Raymond Hettinger9013ccf2019-04-23 00:06:35 -0700958Added :func:`statistics.quantiles` that divides data or a distribution
959in to equiprobable intervals (e.g. quartiles, deciles, or percentiles).
960(Contributed by Raymond Hettinger in :issue:`36546`.)
961
Raymond Hettinger11c79532019-02-23 14:44:07 -0800962Added :class:`statistics.NormalDist`, a tool for creating
963and manipulating normal distributions of a random variable.
964(Contributed by Raymond Hettinger in :issue:`36018`.)
965
966::
967
968 >>> temperature_feb = NormalDist.from_samples([4, 12, -3, 2, 7, 14])
Raymond Hettinger671d7822019-05-01 17:49:12 -0700969 >>> temperature_feb.mean
970 6.0
971 >>> temperature_feb.stdev
972 6.356099432828281
Raymond Hettinger11c79532019-02-23 14:44:07 -0800973
974 >>> temperature_feb.cdf(3) # Chance of being under 3 degrees
975 0.3184678262814532
976 >>> # Relative chance of being 7 degrees versus 10 degrees
977 >>> temperature_feb.pdf(7) / temperature_feb.pdf(10)
978 1.2039930378537762
979
Raymond Hettinger671d7822019-05-01 17:49:12 -0700980 >>> el_niño = NormalDist(4, 2.5)
981 >>> temperature_feb += el_niño # Add in a climate effect
Raymond Hettinger11c79532019-02-23 14:44:07 -0800982 >>> temperature_feb
983 NormalDist(mu=10.0, sigma=6.830080526611674)
984
985 >>> temperature_feb * (9/5) + 32 # Convert to Fahrenheit
986 NormalDist(mu=50.0, sigma=12.294144947901014)
987 >>> temperature_feb.samples(3) # Generate random samples
988 [7.672102882379219, 12.000027119750287, 4.647488369766392]
989
Raymond Hettinger47d99872019-02-21 15:06:29 -0800990
Victor Stinneref9d9b62019-05-22 11:28:22 +0200991sys
992---
993
994Add new :func:`sys.unraisablehook` function which can be overridden to control
995how "unraisable exceptions" are handled. It is called when an exception has
996occurred but there is no way for Python to handle it. For example, when a
997destructor raises an exception or during garbage collection
998(:func:`gc.collect`).
Victor Stinner01ae8972019-06-03 16:28:01 +0200999(Contributed by Victor Stinner in :issue:`36829`.)
Victor Stinneref9d9b62019-05-22 11:28:22 +02001000
1001
CAM Gerlache680c3d2019-03-21 09:44:51 -05001002tarfile
1003-------
1004
1005The :mod:`tarfile` module now defaults to the modern pax (POSIX.1-2001)
1006format for new archives, instead of the previous GNU-specific one.
1007This improves cross-platform portability with a consistent encoding (UTF-8)
1008in a standardized and extensible format, and offers several other benefits.
1009(Contributed by C.A.M. Gerlach in :issue:`36268`.)
1010
1011
Victor Stinnercd590a72019-05-28 00:39:52 +02001012threading
1013---------
1014
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001015Add a new :func:`threading.excepthook` function which handles uncaught
1016:meth:`threading.Thread.run` exception. It can be overridden to control how
1017uncaught :meth:`threading.Thread.run` exceptions are handled.
1018(Contributed by Victor Stinner in :issue:`1230540`.)
Jake Tesler84846b02019-07-30 14:41:46 -07001019
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001020Add a new :func:`threading.get_native_id` function and
1021a :data:`~threading.Thread.native_id`
1022attribute to the :class:`threading.Thread` class. These return the native
1023integral Thread ID of the current thread assigned by the kernel.
1024This feature is only available on certain platforms, see
1025:func:`get_native_id <threading.get_native_id>` for more information.
1026(Contributed by Jake Tesler in :issue:`36084`.)
Victor Stinnercd590a72019-05-28 00:39:52 +02001027
1028
Tal Einatdfba1f62018-10-24 10:20:05 +03001029tokenize
1030--------
1031
1032The :mod:`tokenize` module now implicitly emits a ``NEWLINE`` token when
1033provided with input that does not have a trailing new line. This behavior
1034now matches what the C tokenizer does internally.
1035(Contributed by Ammar Askar in :issue:`33899`.)
1036
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001037
Juliette Monselaf5658a2018-10-08 18:29:24 +02001038tkinter
1039-------
1040
1041Added methods :meth:`~tkinter.Spinbox.selection_from`,
1042:meth:`~tkinter.Spinbox.selection_present`,
1043:meth:`~tkinter.Spinbox.selection_range` and
1044:meth:`~tkinter.Spinbox.selection_to`
1045in the :class:`tkinter.Spinbox` class.
1046(Contributed by Juliette Monsel in :issue:`34829`.)
1047
Juliette Monselbf034712018-10-12 18:44:10 +02001048Added method :meth:`~tkinter.Canvas.moveto`
1049in the :class:`tkinter.Canvas` class.
1050(Contributed by Juliette Monsel in :issue:`23831`.)
1051
Zackery Spytz50866e92019-04-05 04:17:13 -06001052The :class:`tkinter.PhotoImage` class now has
1053:meth:`~tkinter.PhotoImage.transparency_get` and
1054:meth:`~tkinter.PhotoImage.transparency_set` methods. (Contributed by
1055Zackery Spytz in :issue:`25451`.)
1056
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001057
Joannah Nanjekye572168a2019-01-10 19:56:38 +03001058time
1059----
1060
1061Added new clock :data:`~time.CLOCK_UPTIME_RAW` for macOS 10.12.
1062(Contributed by Joannah Nanjekye in :issue:`35702`.)
1063
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001064
1065typing
1066------
1067
1068The :mod:`typing` module incorporates several new features:
1069
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001070* A dictionary type with per-key types. See :pep:`589` and
1071 :class:`typing.TypedDict`.
Raymond Hettingera3291532019-10-13 23:32:03 -07001072 TypedDict uses only string keys. By default, every key is required
1073 to be present. Specify "total=False" to allow keys to be optional::
1074
1075 class Location(TypedDict, total=False):
1076 lat_long: tuple
1077 grid_square: str
1078 xy_coordinate: tuple
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001079
1080* Literal types. See :pep:`586` and :class:`typing.Literal`.
Raymond Hettingera3291532019-10-13 23:32:03 -07001081 Literal types indicate that a parameter or return value
1082 is constrained to one or more specific literal values::
1083
1084 def get_status(port: int) -> Literal['connected', 'disconnected']:
1085 ...
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001086
1087* "Final" variables, functions, methods and classes. See :pep:`591`,
1088 :class:`typing.Final` and :func:`typing.final`.
Raymond Hettingera3291532019-10-13 23:32:03 -07001089 The final qualifier instructs a static type checker to restrict
1090 subclassing, overriding, or reassignment::
1091
1092 pi: Final[float] = 3.1415926536
1093
1094* Protocol definitions. See :pep:`544`, :class:`typing.Protocol` and
1095 :func:`typing.runtime_checkable`. Simple ABCs like
1096 :class:`typing.SupportsInt` are now ``Protocol`` subclasses.
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001097
1098* New protocol class :class:`typing.SupportsIndex`.
1099
1100* New functions :func:`typing.get_origin` and :func:`typing.get_args`.
1101
1102
Max Bélanger2810dd72018-11-04 15:58:24 -08001103unicodedata
1104-----------
1105
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001106The :mod:`unicodedata` module has been upgraded to use the `Unicode 12.1.0
1107<http://blog.unicode.org/2019/05/unicode-12-1-en.html>`_ release.
Raymond Hettinger482b6b52019-05-01 17:48:13 -07001108
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001109New function :func:`~unicodedata.is_normalized` can be used to verify a string
1110is in a specific normal form, often much faster than by actually normalizing
1111the string. (Contributed by Max Belanger, David Euresti, and Greg Price in
1112:issue:`32285` and :issue:`37966`).
Max Bélanger2810dd72018-11-04 15:58:24 -08001113
Raymond Hettinger482b6b52019-05-01 17:48:13 -07001114
Lisa Roach0f221d02018-11-08 18:34:33 -08001115unittest
1116--------
1117
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001118Added :class:`AsyncMock` to support an asynchronous version of :class:`Mock`.
1119Appropriate new assert functions for testing have been added as well.
1120(Contributed by Lisa Roach in :issue:`26467`).
Lisa Roach77b3b772019-05-20 09:19:53 -07001121
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001122Added :func:`~unittest.addModuleCleanup()` and
1123:meth:`~unittest.TestCase.addClassCleanup()` to unittest to support
1124cleanups for :func:`~unittest.setUpModule()` and
1125:meth:`~unittest.TestCase.setUpClass()`.
1126(Contributed by Lisa Roach in :issue:`24412`.)
Lisa Roach0f221d02018-11-08 18:34:33 -08001127
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001128Several mock assert functions now also print a list of actual calls upon
1129failure. (Contributed by Petter Strandmark in :issue:`35047`.)
Petter Strandmark001d63c2019-06-04 21:34:49 +02001130
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001131:mod:`unittest` module gained support for coroutines to be used as test cases
1132with :class:`unittest.IsolatedAsyncioTestCase`.
1133(Contributed by Andrew Svetlov in :issue:`32972`.)
Xtreak6a9fd662019-09-11 12:02:14 +01001134
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001135Example::
Xtreak6a9fd662019-09-11 12:02:14 +01001136
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001137 import unittest
Xtreak6a9fd662019-09-11 12:02:14 +01001138
1139
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001140 class TestRequest(unittest.IsolatedAsyncioTestCase):
Xtreak6a9fd662019-09-11 12:02:14 +01001141
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001142 async def asyncSetUp(self):
1143 self.connection = await AsyncConnection()
Xtreak6a9fd662019-09-11 12:02:14 +01001144
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001145 async def test_get(self):
1146 response = await self.connection.get("https://example.com")
1147 self.assertEqual(response.status_code, 200)
Xtreak6a9fd662019-09-11 12:02:14 +01001148
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001149 async def asyncTearDown(self):
1150 await self.connection.close()
Xtreak6a9fd662019-09-11 12:02:14 +01001151
1152
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001153 if __name__ == "__main__":
1154 unittest.main()
Xtreak6a9fd662019-09-11 12:02:14 +01001155
1156
Brett Cannond64ee1a2018-09-21 15:27:26 -07001157venv
1158----
1159
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001160:mod:`venv` now includes an ``Activate.ps1`` script on all platforms for
1161activating virtual environments under PowerShell Core 6.1.
1162(Contributed by Brett Cannon in :issue:`32718`.)
1163
Brett Cannond64ee1a2018-09-21 15:27:26 -07001164
Mark Dickinson7abb6c02019-04-26 15:56:15 +09001165weakref
1166-------
1167
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001168The proxy objects returned by :func:`weakref.proxy` now support the matrix
1169multiplication operators ``@`` and ``@=`` in addition to the other
1170numeric operators. (Contributed by Mark Dickinson in :issue:`36669`.)
1171
Mark Dickinson7abb6c02019-04-26 15:56:15 +09001172
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001173xml
1174---
1175
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001176As mitigation against DTD and external entity retrieval, the
1177:mod:`xml.dom.minidom` and :mod:`xml.sax` modules no longer process
1178external entities by default.
1179(Contributed by Christian Heimes in :issue:`17239`.)
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001180
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001181The ``.find*()`` methods in the :mod:`xml.etree.ElementTree` module
1182support wildcard searches like ``{*}tag`` which ignores the namespace
1183and ``{namespace}*`` which returns all tags in the given namespace.
1184(Contributed by Stefan Behnel in :issue:`28238`.)
Stefan Behnel47541682019-05-03 20:58:16 +02001185
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001186The :mod:`xml.etree.ElementTree` module provides a new function
1187:func:`–xml.etree.ElementTree.canonicalize()` that implements C14N 2.0.
1188(Contributed by Stefan Behnel in :issue:`13611`.)
Stefan Behnele1d5dd62019-05-01 22:34:13 +02001189
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001190The target object of :class:`xml.etree.ElementTree.XMLParser` can
1191receive namespace declaration events through the new callback methods
1192``start_ns()`` and ``end_ns()``. Additionally, the
1193:class:`xml.etree.ElementTree.TreeBuilder` target can be configured
1194to process events about comments and processing instructions to include
1195them in the generated tree.
1196(Contributed by Stefan Behnel in :issue:`36676` and :issue:`36673`.)
1197
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001198
Ned Deily07a18922018-01-31 18:12:38 -05001199Optimizations
1200=============
1201
Victor Stinner9daecf32019-01-16 00:02:35 +01001202* The :mod:`subprocess` module can now use the :func:`os.posix_spawn` function
1203 in some cases for better performance. Currently, it is only used on macOS
1204 and Linux (using glibc 2.24 or newer) if all these conditions are met:
1205
1206 * *close_fds* is false;
Victor Stinnerf6243ac2019-01-23 19:00:39 +01001207 * *preexec_fn*, *pass_fds*, *cwd* and *start_new_session* parameters
1208 are not set;
Victor Stinner8c349562019-01-16 23:38:06 +01001209 * the *executable* path contains a directory.
Victor Stinner9daecf32019-01-16 00:02:35 +01001210
Victor Stinner01ae8972019-06-03 16:28:01 +02001211 (Contributed by Joannah Nanjekye and Victor Stinner in :issue:`35537`.)
1212
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02001213* :func:`shutil.copyfile`, :func:`shutil.copy`, :func:`shutil.copy2`,
1214 :func:`shutil.copytree` and :func:`shutil.move` use platform-specific
Giampaolo Rodola413d9552019-05-30 14:05:41 +08001215 "fast-copy" syscalls on Linux and macOS in order to copy the file
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07001216 more efficiently.
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02001217 "fast-copy" means that the copying operation occurs within the kernel,
1218 avoiding the use of userspace buffers in Python as in
1219 "``outfd.write(infd.read())``".
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07001220 On Windows :func:`shutil.copyfile` uses a bigger default buffer size (1 MiB
1221 instead of 16 KiB) and a :func:`memoryview`-based variant of
1222 :func:`shutil.copyfileobj` is used.
1223 The speedup for copying a 512 MiB file within the same partition is about
1224 +26% on Linux, +50% on macOS and +40% on Windows. Also, much less CPU cycles
1225 are consumed.
1226 See :ref:`shutil-platform-dependent-efficient-copy-operations` section.
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001227 (Contributed by Giampaolo Rodolà in :issue:`33671`.)
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02001228
Giampaolo Rodola19c46a42018-11-12 06:18:15 -08001229* :func:`shutil.copytree` uses :func:`os.scandir` function and all copy
1230 functions depending from it use cached :func:`os.stat` values. The speedup
1231 for copying a directory with 8000 files is around +9% on Linux, +20% on
1232 Windows and +30% on a Windows SMB share. Also the number of :func:`os.stat`
1233 syscalls is reduced by 38% making :func:`shutil.copytree` especially faster
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001234 on network filesystems. (Contributed by Giampaolo Rodolà in :issue:`33695`.)
Giampaolo Rodola19c46a42018-11-12 06:18:15 -08001235
Łukasz Langac51d8c92018-04-03 23:06:53 -07001236* The default protocol in the :mod:`pickle` module is now Protocol 4,
1237 first introduced in Python 3.4. It offers better performance and smaller
1238 size compared to Protocol 3 available since Python 3.0.
Ned Deily07a18922018-01-31 18:12:38 -05001239
INADA Naokid5c875b2018-07-11 17:42:49 +09001240* Removed one ``Py_ssize_t`` member from ``PyGC_Head``. All GC tracked
1241 objects (e.g. tuple, list, dict) size is reduced 4 or 8 bytes.
1242 (Contributed by Inada Naoki in :issue:`33597`)
1243
Tal Einat54752532018-09-10 16:11:04 +03001244* :class:`uuid.UUID` now uses ``__slots__`` to reduce its memory footprint.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001245 (Contributed by Wouter Bolsterlee and Tal Einat in :issue:`30977`)
Tal Einat54752532018-09-10 16:11:04 +03001246
Raymond Hettinger63fa1cf2019-02-16 12:02:22 -08001247* Improved performance of :func:`operator.itemgetter` by 33%. Optimized
1248 argument handling and added a fast path for the common case of a single
1249 non-negative integer index into a tuple (which is the typical use case in
1250 the standard library). (Contributed by Raymond Hettinger in
1251 :issue:`35664`.)
1252
1253* Sped-up field lookups in :func:`collections.namedtuple`. They are now more
1254 than two times faster, making them the fastest form of instance variable
1255 lookup in Python. (Contributed by Raymond Hettinger, Pablo Galindo, and
Joe Jevnikf36f8922019-02-21 16:00:40 -05001256 Joe Jevnik, Serhiy Storchaka in :issue:`32492`.)
Raymond Hettinger63fa1cf2019-02-16 12:02:22 -08001257
Pablo Galindoc61e2292018-10-28 22:03:18 +00001258* The :class:`list` constructor does not overallocate the internal item buffer
1259 if the input iterable has a known length (the input implements ``__len__``).
Raymond Hettingere1823182019-02-16 12:47:48 -08001260 This makes the created list 12% smaller on average. (Contributed by
1261 Raymond Hettinger and Pablo Galindo in :issue:`33234`.)
Pablo Galindoc61e2292018-10-28 22:03:18 +00001262
Stefan Behneld8b9e1f2019-02-20 18:29:24 +01001263* Doubled the speed of class variable writes. When a non-dunder attribute
1264 was updated, there was an unnecessary call to update slots.
1265 (Contributed by Stefan Behnel, Pablo Galindo Salgado, Raymond Hettinger,
1266 Neil Schemenauer, and Serhiy Storchaka in :issue:`36012`.)
1267
Serhiy Storchaka31913912019-03-14 10:32:22 +02001268* Reduced an overhead of converting arguments passed to many builtin functions
1269 and methods. This sped up calling some simple builtin functions and
1270 methods up to 20--50%. (Contributed by Serhiy Storchaka in :issue:`23867`,
1271 :issue:`35582` and :issue:`36127`.)
1272
Inada Naoki91234a12019-06-03 21:30:58 +09001273* ``LOAD_GLOBAL`` instruction now uses new "per opcode cache" mechanism.
1274 It is about 40% faster now. (Contributed by Yury Selivanov and Inada Naoki in
1275 :issue:`26219`.)
1276
Serhiy Storchakaceeef102018-06-15 11:09:43 +03001277
Ned Deily07a18922018-01-31 18:12:38 -05001278Build and C API Changes
1279=======================
1280
Victor Stinner7efc5262019-06-15 03:24:41 +02001281* Default :data:`sys.abiflags` became an empty string: the ``m`` flag for
1282 pymalloc became useless (builds with and without pymalloc are ABI compatible)
1283 and so has been removed. (Contributed by Victor Stinner in :issue:`36707`.)
1284
1285 Example of changes:
1286
1287 * Only ``python3.8`` program is installed, ``python3.8m`` program is gone.
1288 * Only ``python3.8-config`` script is installed, ``python3.8m-config`` script
1289 is gone.
1290 * The ``m`` flag has been removed from the suffix of dynamic library
1291 filenames: extension modules in the standard library as well as those
1292 produced and installed by third-party packages, like those downloaded from
1293 PyPI. On Linux, for example, the Python 3.7 suffix
1294 ``.cpython-37m-x86_64-linux-gnu.so`` became
1295 ``.cpython-38-x86_64-linux-gnu.so`` in Python 3.8.
1296
Victor Stinnerbd5798f2019-06-14 19:43:43 +02001297* The header files have been reorganized to better separate the different kinds
1298 of APIs:
1299
1300 * ``Include/*.h`` should be the portable public stable C API.
1301 * ``Include/cpython/*.h`` should be the unstable C API specific to CPython;
Victor Stinneraf41c562019-06-20 01:44:58 +02001302 public API, with some private API prefixed by ``_Py`` or ``_PY``.
Victor Stinnerbd5798f2019-06-14 19:43:43 +02001303 * ``Include/internal/*.h`` is the private internal C API very specific to
1304 CPython. This API comes with no backward compatibility warranty and should
1305 not be used outside CPython. It is only exposed for very specific needs
1306 like debuggers and profiles which has to access to CPython internals
1307 without calling functions. This API is now installed by ``make install``.
1308
1309 (Contributed by Victor Stinner in :issue:`35134` and :issue:`35081`,
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001310 work initiated by Eric Snow in Python 3.7.)
Victor Stinnerbd5798f2019-06-14 19:43:43 +02001311
1312* Some macros have been converted to static inline functions: parameter types
1313 and return type are well defined, they don't have issues specific to macros,
1314 variables have a local scopes. Examples:
1315
1316 * :c:func:`Py_INCREF`, :c:func:`Py_DECREF`
1317 * :c:func:`Py_XINCREF`, :c:func:`Py_XDECREF`
1318 * :c:func:`PyObject_INIT`, :c:func:`PyObject_INIT_VAR`
1319 * Private functions: :c:func:`_PyObject_GC_TRACK`,
1320 :c:func:`_PyObject_GC_UNTRACK`, :c:func:`_Py_Dealloc`
1321
1322 (Contributed by Victor Stinner in :issue:`35059`.)
1323
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001324* The :c:func:`PyByteArray_Init` and :c:func:`PyByteArray_Fini` functions have
1325 been removed. They did nothing since Python 2.7.4 and Python 3.2.0, were
1326 excluded from the limited API (stable ABI), and were not documented.
Victor Stinnerc68e3fb2019-06-20 22:41:25 +02001327 (Contributed by Victor Stinner in :issue:`35713`.)
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001328
Serhiy Storchakaceeef102018-06-15 11:09:43 +03001329* The result of :c:func:`PyExceptionClass_Name` is now of type
1330 ``const char *`` rather of ``char *``.
1331 (Contributed by Serhiy Storchaka in :issue:`33818`.)
Ned Deily07a18922018-01-31 18:12:38 -05001332
Antoine Pitrou961d54c2018-07-16 19:03:03 +02001333* The duality of ``Modules/Setup.dist`` and ``Modules/Setup`` has been
1334 removed. Previously, when updating the CPython source tree, one had
1335 to manually copy ``Modules/Setup.dist`` (inside the source tree) to
1336 ``Modules/Setup`` (inside the build tree) in order to reflect any changes
1337 upstream. This was of a small benefit to packagers at the expense of
1338 a frequent annoyance to developers following CPython development, as
1339 forgetting to copy the file could produce build failures.
1340
1341 Now the build system always reads from ``Modules/Setup`` inside the source
1342 tree. People who want to customize that file are encouraged to maintain
1343 their changes in a git fork of CPython or as patch files, as they would do
1344 for any other change to the source tree.
1345
1346 (Contributed by Antoine Pitrou in :issue:`32430`.)
1347
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001348* Functions that convert Python number to C integer like
1349 :c:func:`PyLong_AsLong` and argument parsing functions like
1350 :c:func:`PyArg_ParseTuple` with integer converting format units like ``'i'``
1351 will now use the :meth:`~object.__index__` special method instead of
1352 :meth:`~object.__int__`, if available. The deprecation warning will be
1353 emitted for objects with the ``__int__()`` method but without the
1354 ``__index__()`` method (like :class:`~decimal.Decimal` and
1355 :class:`~fractions.Fraction`). :c:func:`PyNumber_Check` will now return
1356 ``1`` for objects implementing ``__index__()``.
Serhiy Storchakabdbad712019-06-02 00:05:48 +03001357 :c:func:`PyNumber_Long`, :c:func:`PyNumber_Float` and
1358 :c:func:`PyFloat_AsDouble` also now use the ``__index__()`` method if
1359 available.
1360 (Contributed by Serhiy Storchaka in :issue:`36048` and :issue:`20092`.)
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001361
Eddie Elizondo364f0b02019-03-27 07:52:18 -04001362* Heap-allocated type objects will now increase their reference count
1363 in :c:func:`PyObject_Init` (and its parallel macro ``PyObject_INIT``)
1364 instead of in :c:func:`PyType_GenericAlloc`. Types that modify instance
1365 allocation or deallocation may need to be adjusted.
1366 (Contributed by Eddie Elizondo in :issue:`35810`.)
1367
Pablo Galindo4a2edc32019-07-01 11:35:05 +01001368* The new function :c:func:`PyCode_NewWithPosOnlyArgs` allows to create
1369 code objects like :c:func:`PyCode_New`, but with an extra *posonlyargcount*
1370 parameter for indicating the number of positional-only arguments.
1371 (Contributed by Pablo Galindo in :issue:`37221`.)
1372
Victor Stinner1ce152a2019-09-24 17:44:15 +02001373* :c:func:`Py_SetPath` now sets :data:`sys.executable` to the program full
1374 path (:c:func:`Py_GetProgramFullPath`) rather than to the program name
1375 (:c:func:`Py_GetProgramName`).
1376 (Contributed by Victor Stinner in :issue:`38234`.)
1377
Ned Deily07a18922018-01-31 18:12:38 -05001378
1379Deprecated
1380==========
1381
Victor Stinner1da44622019-07-05 10:44:12 +02001382* The distutils ``bdist_wininst`` command is now deprecated, use
1383 ``bdist_wheel`` (wheel packages) instead.
1384 (Contributed by Victor Stinner in :issue:`37481`.)
1385
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001386* Deprecated methods ``getchildren()`` and ``getiterator()`` in
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001387 the :mod:`~xml.etree.ElementTree` module now emit a
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001388 :exc:`DeprecationWarning` instead of :exc:`PendingDeprecationWarning`.
1389 They will be removed in Python 3.9.
1390 (Contributed by Serhiy Storchaka in :issue:`29209`.)
Ned Deily07a18922018-01-31 18:12:38 -05001391
Elvis Pranskevichus22d25082018-07-30 11:42:43 +01001392* Passing an object that is not an instance of
1393 :class:`concurrent.futures.ThreadPoolExecutor` to
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001394 :meth:`asyncio.loop.set_default_executor()` is
Elvis Pranskevichus22d25082018-07-30 11:42:43 +01001395 deprecated and will be prohibited in Python 3.9.
1396 (Contributed by Elvis Pranskevichus in :issue:`34075`.)
1397
Berker Peksagef8861c2018-08-21 17:58:49 +03001398* The :meth:`__getitem__` methods of :class:`xml.dom.pulldom.DOMEventStream`,
1399 :class:`wsgiref.util.FileWrapper` and :class:`fileinput.FileInput` have been
1400 deprecated.
1401
1402 Implementations of these methods have been ignoring their *index* parameter,
1403 and returning the next item instead.
Berker Peksagef8861c2018-08-21 17:58:49 +03001404 (Contributed by Berker Peksag in :issue:`9372`.)
1405
Raymond Hettingerf7b57df2019-03-18 09:53:56 -07001406* The :class:`typing.NamedTuple` class has deprecated the ``_field_types``
1407 attribute in favor of the ``__annotations__`` attribute which has the same
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001408 information. (Contributed by Raymond Hettinger in :issue:`36320`.)
Raymond Hettingerf7b57df2019-03-18 09:53:56 -07001409
Serhiy Storchaka3f228112018-09-27 17:42:37 +03001410* :mod:`ast` classes ``Num``, ``Str``, ``Bytes``, ``NameConstant`` and
1411 ``Ellipsis`` are considered deprecated and will be removed in future Python
1412 versions. :class:`~ast.Constant` should be used instead.
1413 (Contributed by Serhiy Storchaka in :issue:`32892`.)
1414
Serhiy Storchakac3ea41e2019-08-26 10:13:19 +03001415* :class:`ast.NodeVisitor` methods ``visit_Num()``, ``visit_Str()``,
1416 ``visit_Bytes()``, ``visit_NameConstant()`` and ``visit_Ellipsis()`` are
1417 deprecated now and will not be called in future Python versions.
1418 Add the :meth:`~ast.NodeVisitor.visit_Constant` method to handle all
1419 constant nodes.
1420 (Contributed by Serhiy Storchaka in :issue:`36917`.)
1421
Serhiy Storchakafec35c92018-10-27 08:00:41 +03001422* The following functions and methods are deprecated in the :mod:`gettext`
1423 module: :func:`~gettext.lgettext`, :func:`~gettext.ldgettext`,
1424 :func:`~gettext.lngettext` and :func:`~gettext.ldngettext`.
1425 They return encoded bytes, and it's possible that you will get unexpected
1426 Unicode-related exceptions if there are encoding problems with the
1427 translated strings. It's much better to use alternatives which return
1428 Unicode strings in Python 3. These functions have been broken for a long time.
1429
1430 Function :func:`~gettext.bind_textdomain_codeset`, methods
1431 :meth:`~gettext.NullTranslations.output_charset` and
1432 :meth:`~gettext.NullTranslations.set_output_charset`, and the *codeset*
1433 parameter of functions :func:`~gettext.translation` and
1434 :func:`~gettext.install` are also deprecated, since they are only used for
1435 for the ``l*gettext()`` functions.
Serhiy Storchakafec35c92018-10-27 08:00:41 +03001436 (Contributed by Serhiy Storchaka in :issue:`33710`.)
1437
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001438* The :meth:`~threading.Thread.isAlive()` method of :class:`threading.Thread`
1439 has been deprecated.
Dong-hee Na89669ff2019-01-17 21:14:45 +09001440 (Contributed by Dong-hee Na in :issue:`35283`.)
Ned Deily07a18922018-01-31 18:12:38 -05001441
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001442* Many builtin and extension functions that take integer arguments will
1443 now emit a deprecation warning for :class:`~decimal.Decimal`\ s,
1444 :class:`~fractions.Fraction`\ s and any other objects that can be converted
1445 to integers only with a loss (e.g. that have the :meth:`~object.__int__`
1446 method but do not have the :meth:`~object.__index__` method). In future
1447 version they will be errors.
1448 (Contributed by Serhiy Storchaka in :issue:`36048`.)
1449
Serhiy Storchaka42a139e2019-04-01 09:16:35 +03001450* Deprecated passing the following arguments as keyword arguments:
1451
1452 - *func* in :func:`functools.partialmethod`, :func:`weakref.finalize`,
1453 :meth:`profile.Profile.runcall`, :meth:`cProfile.Profile.runcall`,
1454 :meth:`bdb.Bdb.runcall`, :meth:`trace.Trace.runfunc` and
1455 :func:`curses.wrapper`.
Serhiy Storchaka2085bd02019-06-01 11:00:15 +03001456 - *function* in :meth:`unittest.TestCase.addCleanup`.
Serhiy Storchaka42a139e2019-04-01 09:16:35 +03001457 - *fn* in the :meth:`~concurrent.futures.Executor.submit` method of
1458 :class:`concurrent.futures.ThreadPoolExecutor` and
1459 :class:`concurrent.futures.ProcessPoolExecutor`.
1460 - *callback* in :meth:`contextlib.ExitStack.callback`,
1461 :meth:`contextlib.AsyncExitStack.callback` and
1462 :meth:`contextlib.AsyncExitStack.push_async_callback`.
1463 - *c* and *typeid* in the :meth:`~multiprocessing.managers.Server.create`
1464 method of :class:`multiprocessing.managers.Server` and
1465 :class:`multiprocessing.managers.SharedMemoryServer`.
1466 - *obj* in :func:`weakref.finalize`.
1467
1468 In future releases of Python they will be :ref:`positional-only
1469 <positional-only_parameter>`.
1470 (Contributed by Serhiy Storchaka in :issue:`36492`.)
1471
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001472
Victor Stinner73104fa2018-11-29 09:58:20 +01001473API and Feature Removals
1474========================
1475
1476The following features and APIs have been removed from Python 3.8:
1477
Victor Stinnerd7538dd2018-12-14 13:37:26 +01001478* The :mod:`macpath` module, deprecated in Python 3.7, has been removed.
1479 (Contributed by Victor Stinner in :issue:`35471`.)
1480
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001481* The function :func:`platform.popen` has been removed, after having been
1482 deprecated since Python 3.3: use :func:`os.popen` instead.
Victor Stinner01ae8972019-06-03 16:28:01 +02001483 (Contributed by Victor Stinner in :issue:`35345`.)
Ned Deily07a18922018-01-31 18:12:38 -05001484
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001485* The function :func:`time.clock` has been removed, after having been
1486 deprecated since Python 3.3: use :func:`time.perf_counter` or
1487 :func:`time.process_time` instead, depending
1488 on your requirements, to have well-defined behavior.
Victor Stinner01ae8972019-06-03 16:28:01 +02001489 (Contributed by Matthias Bussonnier in :issue:`36895`.)
Matthias Bussonnierb6a09ae2019-05-13 12:23:07 -07001490
Brett Cannona8c34242018-04-20 14:15:40 -07001491* The ``pyvenv`` script has been removed in favor of ``python3.8 -m venv``
1492 to help eliminate confusion as to what Python interpreter the ``pyvenv``
1493 script is tied to. (Contributed by Brett Cannon in :issue:`25427`.)
Ned Deily07a18922018-01-31 18:12:38 -05001494
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001495* ``parse_qs``, ``parse_qsl``, and ``escape`` are removed from the :mod:`cgi`
1496 module. They are deprecated in Python 3.2 or older. They should be imported
Simon Willison1abf5432019-09-11 09:25:26 -05001497 from the ``urllib.parse`` and ``html`` modules instead.
INADA Naoki698865d2018-06-19 17:28:50 +09001498
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001499* ``filemode`` function is removed from the :mod:`tarfile` module.
INADA Naoki461a1c42018-06-28 17:10:36 +09001500 It is not documented and deprecated since Python 3.3.
INADA Naoki698865d2018-06-19 17:28:50 +09001501
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001502* The :class:`~xml.etree.ElementTree.XMLParser` constructor no longer accepts
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001503 the *html* argument. It never had an effect and was deprecated in Python 3.4.
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001504 All other parameters are now :ref:`keyword-only <keyword-only_parameter>`.
1505 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1506
1507* Removed the ``doctype()`` method of :class:`~xml.etree.ElementTree.XMLParser`.
1508 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1509
Inada Naoki6a16b182019-03-18 15:44:11 +09001510* "unicode_internal" codec is removed.
1511 (Contributed by Inada Naoki in :issue:`36297`.)
1512
Aviv Palivodae6576242019-05-09 21:05:45 +03001513* The ``Cache`` and ``Statement`` objects of the :mod:`sqlite3` module are not
1514 exposed to the user.
1515 (Contributed by Aviv Palivoda in :issue:`30262`.)
1516
Matthias Bussonnier1a3faf92019-05-20 13:44:11 -07001517* The ``bufsize`` keyword argument of :func:`fileinput.input` and
1518 :func:`fileinput.FileInput` which was ignored and deprecated since Python 3.6
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001519 has been removed. :issue:`36952` (Contributed by Matthias Bussonnier.)
Matthias Bussonnier1a3faf92019-05-20 13:44:11 -07001520
Matthias Bussonnier382034b2019-05-28 10:30:35 -07001521* The functions :func:`sys.set_coroutine_wrapper` and
1522 :func:`sys.get_coroutine_wrapper` deprecated in Python 3.7 have been removed;
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001523 :issue:`36933` (Contributed by Matthias Bussonnier.)
Matthias Bussonnier3880f262019-05-28 00:10:59 -07001524
Ned Deily07a18922018-01-31 18:12:38 -05001525
1526Porting to Python 3.8
1527=====================
1528
1529This section lists previously described changes and other bugfixes
1530that may require changes to your code.
1531
1532
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001533Changes in Python behavior
1534--------------------------
1535
1536* Yield expressions (both ``yield`` and ``yield from`` clauses) are now disallowed
1537 in comprehensions and generator expressions (aside from the iterable expression
Serhiy Storchaka2b57c432018-12-19 08:09:46 +02001538 in the leftmost :keyword:`!for` clause).
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001539 (Contributed by Serhiy Storchaka in :issue:`10544`.)
1540
Serhiy Storchaka3bcbedc2019-01-18 07:47:48 +02001541* The compiler now produces a :exc:`SyntaxWarning` when identity checks
1542 (``is`` and ``is not``) are used with certain types of literals
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001543 (e.g. strings, numbers). These can often work by accident in CPython,
Serhiy Storchaka3bcbedc2019-01-18 07:47:48 +02001544 but are not guaranteed by the language spec. The warning advises users
1545 to use equality tests (``==`` and ``!=``) instead.
1546 (Contributed by Serhiy Storchaka in :issue:`34850`.)
1547
Serhiy Storchaka7a0630c2019-04-08 14:34:04 +03001548* The CPython interpreter can swallow exceptions in some circumstances.
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001549 In Python 3.8 this happens in fewer cases. In particular, exceptions
Serhiy Storchaka7a0630c2019-04-08 14:34:04 +03001550 raised when getting the attribute from the type dictionary are no longer
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001551 ignored. (Contributed by Serhiy Storchaka in :issue:`35459`.)
Serhiy Storchaka7a0630c2019-04-08 14:34:04 +03001552
Serhiy Storchaka96aeaec2019-05-06 22:29:40 +03001553* Removed ``__str__`` implementations from builtin types :class:`bool`,
1554 :class:`int`, :class:`float`, :class:`complex` and few classes from
1555 the standard library. They now inherit ``__str__()`` from :class:`object`.
1556 As result, defining the ``__repr__()`` method in the subclass of these
barioddd6117c2019-09-27 20:01:33 +02001557 classes will affect their string representation.
Serhiy Storchaka96aeaec2019-05-06 22:29:40 +03001558 (Contributed by Serhiy Storchaka in :issue:`36793`.)
1559
Michael Felt9d949f72019-04-12 16:15:32 +02001560* On AIX, :attr:`sys.platform` doesn't contain the major version anymore.
1561 It is always ``'aix'``, instead of ``'aix3'`` .. ``'aix7'``. Since
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001562 older Python versions include the version number, so it is recommended to
1563 always use ``sys.platform.startswith('aix')``.
Michael Felt9d949f72019-04-12 16:15:32 +02001564 (Contributed by M. Felt in :issue:`36588`.)
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001565
Joannah Nanjekyef781d202019-04-29 04:38:45 -04001566* :c:func:`PyEval_AcquireLock` and :c:func:`PyEval_AcquireThread` now
1567 terminate the current thread if called while the interpreter is
1568 finalizing, making them consistent with :c:func:`PyEval_RestoreThread`,
1569 :c:func:`Py_END_ALLOW_THREADS`, and :c:func:`PyGILState_Ensure`. If this
Raymond Hettingera3291532019-10-13 23:32:03 -07001570 behavior is not desired, guard the call by checking :c:func:`_Py_IsFinalizing`
Joannah Nanjekyef781d202019-04-29 04:38:45 -04001571 or :c:func:`sys.is_finalizing`.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001572 (Contributed by Joannah Nanjekye in :issue:`36475`.)
1573
Joannah Nanjekyef781d202019-04-29 04:38:45 -04001574
Serhiy Storchaka97f1ca12018-02-01 18:49:21 +02001575Changes in the Python API
1576-------------------------
1577
Victor Stinner689830e2019-06-26 17:31:12 +02001578* The :func:`os.getcwdb` function now uses the UTF-8 encoding on Windows,
1579 rather than the ANSI code page: see :pep:`529` for the rationale. The
1580 function is no longer deprecated on Windows.
1581 (Contributed by Victor Stinner in :issue:`37412`.)
1582
Victor Stinnerd7befad2019-04-25 14:30:16 +02001583* :class:`subprocess.Popen` can now use :func:`os.posix_spawn` in some cases
1584 for better performance. On Windows Subsystem for Linux and QEMU User
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001585 Emulation, the :class:`Popen` constructor using :func:`os.posix_spawn` no longer raises an
1586 exception on errors like "missing program". Instead the child process fails with a
Victor Stinnerd7befad2019-04-25 14:30:16 +02001587 non-zero :attr:`~Popen.returncode`.
Victor Stinner01ae8972019-06-03 16:28:01 +02001588 (Contributed by Joannah Nanjekye and Victor Stinner in :issue:`35537`.)
Victor Stinnerd7befad2019-04-25 14:30:16 +02001589
Christian Heimes98d90f72019-08-27 23:36:56 +02001590* The *preexec_fn* argument of * :class:`subprocess.Popen` is no longer
1591 compatible with subinterpreters. The use of the parameter in a
1592 subinterpreter now raises :exc:`RuntimeError`.
1593 (Contributed by Eric Snow in :issue:`34651`, modified by Christian Heimes
1594 in :issue:`37951`.)
1595
Victor Stinner74125a62019-04-15 18:23:20 +02001596* The :meth:`imap.IMAP4.logout` method no longer ignores silently arbitrary
1597 exceptions.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001598 (Contributed by Victor Stinner in :issue:`36348`.)
Victor Stinner74125a62019-04-15 18:23:20 +02001599
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001600* The function :func:`platform.popen` has been removed, after having been deprecated since
Victor Stinner73104fa2018-11-29 09:58:20 +01001601 Python 3.3: use :func:`os.popen` instead.
Victor Stinner01ae8972019-06-03 16:28:01 +02001602 (Contributed by Victor Stinner in :issue:`35345`.)
Victor Stinner73104fa2018-11-29 09:58:20 +01001603
Raymond Hettingerfc06a192019-03-12 00:43:27 -07001604* The :func:`statistics.mode` function no longer raises an exception
1605 when given multimodal data. Instead, it returns the first mode
1606 encountered in the input data. (Contributed by Raymond Hettinger
1607 in :issue:`35892`.)
1608
Serhiy Storchaka97f1ca12018-02-01 18:49:21 +02001609* The :meth:`~tkinter.ttk.Treeview.selection` method of the
1610 :class:`tkinter.ttk.Treeview` class no longer takes arguments. Using it with
1611 arguments for changing the selection was deprecated in Python 3.6. Use
1612 specialized methods like :meth:`~tkinter.ttk.Treeview.selection_set` for
1613 changing the selection. (Contributed by Serhiy Storchaka in :issue:`31508`.)
Serhiy Storchaka6c85efa52018-02-05 22:47:31 +02001614
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001615* The :meth:`writexml`, :meth:`toxml` and :meth:`toprettyxml` methods of
1616 :mod:`xml.dom.minidom`, and the :meth:`write` method of :mod:`xml.etree`,
1617 now preserve the attribute order specified by the user.
Diego Rojas06e1e682019-03-16 18:44:56 -05001618 (Contributed by Diego Rojas and Raymond Hettinger in :issue:`34160`.)
1619
Serhiy Storchaka6c85efa52018-02-05 22:47:31 +02001620* A :mod:`dbm.dumb` database opened with flags ``'r'`` is now read-only.
1621 :func:`dbm.dumb.open` with flags ``'r'`` and ``'w'`` no longer creates
1622 a database if it does not exist.
1623 (Contributed by Serhiy Storchaka in :issue:`32749`.)
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001624
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001625* The ``doctype()`` method defined in a subclass of
1626 :class:`~xml.etree.ElementTree.XMLParser` will no longer be called and will
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001627 emit a :exc:`RuntimeWarning` instead of a :exc:`DeprecationWarning`.
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001628 Define the :meth:`doctype() <xml.etree.ElementTree.TreeBuilder.doctype>`
1629 method on a target for handling an XML doctype declaration.
1630 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1631
Serhiy Storchakaf5e7b192018-05-20 08:48:12 +03001632* A :exc:`RuntimeError` is now raised when the custom metaclass doesn't
1633 provide the ``__classcell__`` entry in the namespace passed to
1634 ``type.__new__``. A :exc:`DeprecationWarning` was emitted in Python
1635 3.6--3.7. (Contributed by Serhiy Storchaka in :issue:`23722`.)
1636
Scott Sandersoncebe80b2018-06-07 05:46:42 -04001637* The :class:`cProfile.Profile` class can now be used as a context
1638 manager. (Contributed by Scott Sanderson in :issue:`29235`.)
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001639
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07001640* :func:`shutil.copyfile`, :func:`shutil.copy`, :func:`shutil.copy2`,
1641 :func:`shutil.copytree` and :func:`shutil.move` use platform-specific
1642 "fast-copy" syscalls (see
1643 :ref:`shutil-platform-dependent-efficient-copy-operations` section).
1644
1645* :func:`shutil.copyfile` default buffer size on Windows was changed from
1646 16 KiB to 1 MiB.
1647
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -07001648* The ``PyGC_Head`` struct has changed completely. All code that touched the
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001649 struct member should be rewritten. (See :issue:`33597`.)
INADA Naokid5c875b2018-07-11 17:42:49 +09001650
Eric Snowbe3b2952019-02-23 11:35:52 -07001651* The ``PyInterpreterState`` struct has been moved into the "internal"
1652 header files (specifically Include/internal/pycore_pystate.h). An
1653 opaque ``PyInterpreterState`` is still available as part of the public
1654 API (and stable ABI). The docs indicate that none of the struct's
1655 fields are public, so we hope no one has been using them. However,
1656 if you do rely on one or more of those private fields and have no
1657 alternative then please open a BPO issue. We'll work on helping
1658 you adjust (possibly including adding accessor functions to the
1659 public API). (See :issue:`35886`.)
1660
Alex Grönholmcca4eec2018-08-09 00:06:47 +03001661* Asyncio tasks can now be named, either by passing the ``name`` keyword
1662 argument to :func:`asyncio.create_task` or
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001663 the :meth:`~asyncio.loop.create_task` event loop method, or by
Alex Grönholmcca4eec2018-08-09 00:06:47 +03001664 calling the :meth:`~asyncio.Task.set_name` method on the task object. The
1665 task name is visible in the ``repr()`` output of :class:`asyncio.Task` and
1666 can also be retrieved using the :meth:`~asyncio.Task.get_name` method.
1667
Berker Peksage7d4b2f2018-08-22 21:21:05 +03001668* The :meth:`mmap.flush() <mmap.mmap.flush>` method now returns ``None`` on
1669 success and raises an exception on error under all platforms. Previously,
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001670 its behavior was platform-dependent: a nonzero value was returned on success;
Berker Peksage7d4b2f2018-08-22 21:21:05 +03001671 zero was returned on error under Windows. A zero value was returned on
1672 success; an exception was raised on error under Unix.
1673 (Contributed by Berker Peksag in :issue:`2122`.)
1674
Andrés Delfinoca682612018-11-07 14:29:14 -03001675* :mod:`xml.dom.minidom` and :mod:`xml.sax` modules no longer process
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001676 external entities by default.
1677 (Contributed by Christian Heimes in :issue:`17239`.)
INADA Naokid5c875b2018-07-11 17:42:49 +09001678
Xiang Zhang4fb0b8b2018-12-12 20:46:55 +08001679* Deleting a key from a read-only :mod:`dbm` database (:mod:`dbm.dumb`,
1680 :mod:`dbm.gnu` or :mod:`dbm.ndbm`) raises :attr:`error` (:exc:`dbm.dumb.error`,
1681 :exc:`dbm.gnu.error` or :exc:`dbm.ndbm.error`) instead of :exc:`KeyError`.
1682 (Contributed by Xiang Zhang in :issue:`33106`.)
1683
Steve Dower8ef864d2019-03-12 15:15:26 -07001684* :func:`~os.path.expanduser` on Windows now prefers the :envvar:`USERPROFILE`
1685 environment variable and does not use :envvar:`HOME`, which is not normally
1686 set for regular user accounts.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001687 (Contributed by Anthony Sottile in :issue:`36264`.)
Steve Dower8ef864d2019-03-12 15:15:26 -07001688
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001689* The exception :class:`asyncio.CancelledError` now inherits from
Phil Jonese634da22019-10-12 17:46:13 +00001690 :class:`BaseException` rather than a :class:`Exception`.
1691 (Contributed by Yury Selivanov in :issue:`13528`.)
1692
Steve Dower2438cdf2019-03-29 16:37:16 -07001693.. _bpo-36085-whatsnew:
1694
1695* DLL dependencies for extension modules and DLLs loaded with :mod:`ctypes` on
1696 Windows are now resolved more securely. Only the system paths, the directory
1697 containing the DLL or PYD file, and directories added with
1698 :func:`~os.add_dll_directory` are searched for load-time dependencies.
1699 Specifically, :envvar:`PATH` and the current working directory are no longer
1700 used, and modifications to these will no longer have any effect on normal DLL
1701 resolution. If your application relies on these mechanisms, you should check
1702 for :func:`~os.add_dll_directory` and if it exists, use it to add your DLLs
Steve Dower79da3882019-03-30 20:58:17 -07001703 directory while loading your library. Note that Windows 7 users will need to
1704 ensure that Windows Update KB2533625 has been installed (this is also verified
1705 by the installer).
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001706 (Contributed by Steve Dower in :issue:`36085`.)
Steve Dower2438cdf2019-03-29 16:37:16 -07001707
Pablo Galindof2cf1e32019-04-13 17:05:14 +01001708* The header files and functions related to pgen have been removed after its
1709 replacement by a pure Python implementation. (Contributed by Pablo Galindo
1710 in :issue:`36623`.)
1711
Pablo Galindo5d23e282019-05-12 22:45:52 +01001712* :class:`types.CodeType` has a new parameter in the second position of the
1713 constructor (*posonlyargcount*) to support positional-only arguments defined
Pablo Galindocd74e662019-06-01 18:08:04 +01001714 in :pep:`570`. The first argument (*argcount*) now represents the total
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001715 number of positional arguments (including positional-only arguments). The new
Pablo Galindocd74e662019-06-01 18:08:04 +01001716 ``replace()`` method of :class:`types.CodeType` can be used to make the code
1717 future-proof.
Pablo Galindo5d23e282019-05-12 22:45:52 +01001718
Xiang Zhang4fb0b8b2018-12-12 20:46:55 +08001719
Inada Naokid3c72a22019-03-23 21:04:40 +09001720Changes in the C API
1721--------------------
1722
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001723* The :c:type:`PyCompilerFlags` structure got a new *cf_feature_version*
Victor Stinner2c9b4982019-06-13 02:01:29 +02001724 field. It should be initialized to ``PY_MINOR_VERSION``. The field is ignored
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001725 by default, and is used if and only if ``PyCF_ONLY_AST`` flag is set in
Victor Stinner2c9b4982019-06-13 02:01:29 +02001726 *cf_flags*.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001727 (Contributed by Guido van Rossum in :issue:`35766`.)
Victor Stinner2c9b4982019-06-13 02:01:29 +02001728
Victor Stinnerd5d9e812019-05-13 12:35:37 +02001729* The :c:func:`PyEval_ReInitThreads` function has been removed from the C API.
1730 It should not be called explicitly: use :c:func:`PyOS_AfterFork_Child`
1731 instead.
1732 (Contributed by Victor Stinner in :issue:`36728`.)
1733
E. M. Brayc994c8f2019-05-24 17:33:47 +02001734* On Unix, C extensions are no longer linked to libpython except on Android
1735 and Cygwin. When Python is embedded, ``libpython`` must not be loaded with
xdegaye254b3092019-04-29 09:27:40 +02001736 ``RTLD_LOCAL``, but ``RTLD_GLOBAL`` instead. Previously, using
E. M. Brayc994c8f2019-05-24 17:33:47 +02001737 ``RTLD_LOCAL``, it was already not possible to load C extensions which
1738 were not linked to ``libpython``, like C extensions of the standard
1739 library built by the ``*shared*`` section of ``Modules/Setup``.
Victor Stinner01ae8972019-06-03 16:28:01 +02001740 (Contributed by Victor Stinner in :issue:`21536`.)
Victor Stinner8c3ecc62019-04-25 20:13:10 +02001741
Inada Naokid3c72a22019-03-23 21:04:40 +09001742* Use of ``#`` variants of formats in parsing or building value (e.g.
1743 :c:func:`PyArg_ParseTuple`, :c:func:`Py_BuildValue`, :c:func:`PyObject_CallFunction`,
1744 etc.) without ``PY_SSIZE_T_CLEAN`` defined raises ``DeprecationWarning`` now.
1745 It will be removed in 3.10 or 4.0. Read :ref:`arg-parsing` for detail.
1746 (Contributed by Inada Naoki in :issue:`36381`.)
1747
Eddie Elizondo364f0b02019-03-27 07:52:18 -04001748* Instances of heap-allocated types (such as those created with
1749 :c:func:`PyType_FromSpec`) hold a reference to their type object.
1750 Increasing the reference count of these type objects has been moved from
1751 :c:func:`PyType_GenericAlloc` to the more low-level functions,
1752 :c:func:`PyObject_Init` and :c:func:`PyObject_INIT`.
1753 This makes types created through :c:func:`PyType_FromSpec` behave like
1754 other classes in managed code.
1755
1756 Statically allocated types are not affected.
1757
1758 For the vast majority of cases, there should be no side effect.
1759 However, types that manually increase the reference count after allocating
1760 an instance (perhaps to work around the bug) may now become immortal.
1761 To avoid this, these classes need to call Py_DECREF on the type object
1762 during instance deallocation.
1763
1764 To correctly port these types into 3.8, please apply the following
1765 changes:
1766
1767 * Remove :c:macro:`Py_INCREF` on the type object after allocating an
1768 instance - if any.
1769 This may happen after calling :c:func:`PyObject_New`,
1770 :c:func:`PyObject_NewVar`, :c:func:`PyObject_GC_New`,
1771 :c:func:`PyObject_GC_NewVar`, or any other custom allocator that uses
1772 :c:func:`PyObject_Init` or :c:func:`PyObject_INIT`.
1773
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001774 Example:
1775
1776 .. code-block:: c
Eddie Elizondo364f0b02019-03-27 07:52:18 -04001777
1778 static foo_struct *
1779 foo_new(PyObject *type) {
1780 foo_struct *foo = PyObject_GC_New(foo_struct, (PyTypeObject *) type);
1781 if (foo == NULL)
1782 return NULL;
1783 #if PY_VERSION_HEX < 0x03080000
1784 // Workaround for Python issue 35810; no longer necessary in Python 3.8
1785 PY_INCREF(type)
1786 #endif
1787 return foo;
1788 }
1789
1790 * Ensure that all custom ``tp_dealloc`` functions of heap-allocated types
1791 decrease the type's reference count.
1792
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001793 Example:
1794
1795 .. code-block:: c
Eddie Elizondo364f0b02019-03-27 07:52:18 -04001796
1797 static void
1798 foo_dealloc(foo_struct *instance) {
1799 PyObject *type = Py_TYPE(instance);
1800 PyObject_GC_Del(instance);
1801 #if PY_VERSION_HEX >= 0x03080000
1802 // This was not needed before Python 3.8 (Python issue 35810)
1803 Py_DECREF(type);
1804 #endif
1805 }
1806
1807 (Contributed by Eddie Elizondo in :issue:`35810`.)
1808
Zackery Spytz3c8724f2019-05-28 09:16:33 -06001809* The :c:macro:`Py_DEPRECATED()` macro has been implemented for MSVC.
1810 The macro now must be placed before the symbol name.
1811
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001812 Example:
1813
1814 .. code-block:: c
Zackery Spytz3c8724f2019-05-28 09:16:33 -06001815
1816 Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);
1817
1818 (Contributed by Zackery Spytz in :issue:`33407`.)
1819
Antoine Pitrouada319b2019-05-29 22:12:38 +02001820* The interpreter does not pretend to support binary compatibility of
Xtreak0d702272019-06-03 04:42:33 +05301821 extension types across feature releases, anymore. A :c:type:`PyTypeObject`
Antoine Pitrouada319b2019-05-29 22:12:38 +02001822 exported by a third-party extension module is supposed to have all the
1823 slots expected in the current Python version, including
1824 :c:member:`~PyTypeObject.tp_finalize` (:const:`Py_TPFLAGS_HAVE_FINALIZE`
1825 is not checked anymore before reading :c:member:`~PyTypeObject.tp_finalize`).
1826
1827 (Contributed by Antoine Pitrou in :issue:`32388`.)
1828
Pablo Galindo545a3b82019-05-31 19:33:41 +01001829* The :c:func:`PyCode_New` has a new parameter in the second position (*posonlyargcount*)
1830 to support :pep:`570`, indicating the number of positional-only arguments.
1831
Ivan Levkivskyi47c2de72019-06-19 01:17:47 +01001832* The functions :c:func:`PyNode_AddChild` and :c:func:`PyParser_AddToken` now accept
1833 two additional ``int`` arguments *end_lineno* and *end_col_offset*.
Eddie Elizondo364f0b02019-03-27 07:52:18 -04001834
Steve Dowerf5690922019-06-21 14:28:46 -07001835* The :file:`libpython38.a` file to allow MinGW tools to link directly against
1836 :file:`python38.dll` is no longer included in the regular Windows distribution.
1837 If you require this file, it may be generated with the ``gendef`` and
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001838 ``dlltool`` tools, which are part of the MinGW binutils package:
1839
1840 .. code-block:: shell
Steve Dowerf5690922019-06-21 14:28:46 -07001841
1842 gendef python38.dll > tmp.def
1843 dlltool --dllname python38.dll --def tmp.def --output-lib libpython38.a
1844
1845 The location of an installed :file:`pythonXY.dll` will depend on the
1846 installation options and the version and language of Windows. See
1847 :ref:`using-on-windows` for more information. The resulting library should be
1848 placed in the same directory as :file:`pythonXY.lib`, which is generally the
1849 :file:`libs` directory under your Python installation.
1850
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001851 (Contributed by Steve Dower in :issue:`37351`.)
Steve Dowerf5690922019-06-21 14:28:46 -07001852
1853
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001854CPython bytecode changes
1855------------------------
1856
1857* The interpreter loop has been simplified by moving the logic of unrolling
1858 the stack of blocks into the compiler. The compiler emits now explicit
Serhiy Storchaka3f819ca2018-10-31 02:26:06 +02001859 instructions for adjusting the stack of values and calling the
1860 cleaning-up code for :keyword:`break`, :keyword:`continue` and
1861 :keyword:`return`.
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001862
1863 Removed opcodes :opcode:`BREAK_LOOP`, :opcode:`CONTINUE_LOOP`,
1864 :opcode:`SETUP_LOOP` and :opcode:`SETUP_EXCEPT`. Added new opcodes
1865 :opcode:`ROT_FOUR`, :opcode:`BEGIN_FINALLY`, :opcode:`CALL_FINALLY` and
1866 :opcode:`POP_FINALLY`. Changed the behavior of :opcode:`END_FINALLY`
1867 and :opcode:`WITH_CLEANUP_START`.
1868
1869 (Contributed by Mark Shannon, Antoine Pitrou and Serhiy Storchaka in
1870 :issue:`17611`.)
Serhiy Storchaka702f8f32018-03-23 14:34:35 +02001871
1872* Added new opcode :opcode:`END_ASYNC_FOR` for handling exceptions raised
1873 when awaiting a next item in an :keyword:`async for` loop.
1874 (Contributed by Serhiy Storchaka in :issue:`33041`.)
Raymond Hettingerf75d59e2019-02-02 22:54:56 -08001875
Pablo Galindob51b7132019-06-25 02:41:58 +01001876* The :opcode:`MAP_ADD` now expects the value as the first element in the
1877 stack and the key as the second element. This change was made so the key
1878 is always evaluated before the value in dictionary comprehensions, as
Pablo Galindode9b6062019-06-25 11:55:23 +01001879 proposed by :pep:`572`. (Contributed by Jörn Heissler in :issue:`35224`.)
Pablo Galindob51b7132019-06-25 02:41:58 +01001880
Raymond Hettingerf75d59e2019-02-02 22:54:56 -08001881
1882Demos and Tools
1883---------------
1884
1885* Added a benchmark script for timing various ways to access variables:
1886 ``Tools/scripts/var_access_benchmark.py``.
1887 (Contributed by Raymond Hettinger in :issue:`35884`.)