blob: 089095546fc72d66355f63897c5ff2d01e2456b5 [file] [log] [blame]
Ned Deily07a18922018-01-31 18:12:38 -05001****************************
2 What's New In Python 3.8
3****************************
4
Ned Deily07a18922018-01-31 18:12:38 -05005.. Rules for maintenance:
6
7 * Anyone can add text to this document. Do not spend very much time
8 on the wording of your changes, because your text will probably
9 get rewritten to some degree.
10
11 * The maintainer will go through Misc/NEWS periodically and add
12 changes; it's therefore more important to add your changes to
13 Misc/NEWS than to this file.
14
15 * This is not a complete list of every single change; completeness
16 is the purpose of Misc/NEWS. Some changes I consider too small
17 or esoteric to include. If such a change is added to the text,
18 I'll just remove it. (This is another reason you shouldn't spend
19 too much time on writing your addition.)
20
21 * If you want to draw your new text to the attention of the
22 maintainer, add 'XXX' to the beginning of the paragraph or
23 section.
24
25 * It's OK to just add a fragmentary note about a change. For
26 example: "XXX Describe the transmogrify() function added to the
27 socket module." The maintainer will research the change and
28 write the necessary text.
29
30 * You can comment out your additions if you like, but it's not
31 necessary (especially when a final release is some months away).
32
33 * Credit the author of a patch or bugfix. Just the name is
34 sufficient; the e-mail address isn't necessary.
35
36 * It's helpful to add the bug/patch number as a comment:
37
38 XXX Describe the transmogrify() function added to the socket
39 module.
40 (Contributed by P.Y. Developer in :issue:`12345`.)
41
Raymond Hettinger66a34d32019-08-12 15:55:18 -070042 This saves the maintainer the effort of going through the Git log
Ned Deily07a18922018-01-31 18:12:38 -050043 when researching a change.
44
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070045:Editor: Raymond Hettinger
Ned Deily07a18922018-01-31 18:12:38 -050046
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070047This article explains the new features in Python 3.8, compared to 3.7.
Ned Deily45ab51c2018-02-28 13:58:38 -050048For full details, see the :ref:`changelog <changelog>`.
Ned Deily07a18922018-01-31 18:12:38 -050049
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070050.. testsetup::
Nick Coghlanb9438ce2019-06-09 19:07:42 +100051
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070052 from datetime import date
53 from math import cos, radians
Raymond Hettinger66a34d32019-08-12 15:55:18 -070054 from unicodedata import normalize
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070055 import re
56 import math
Nick Coghlanb9438ce2019-06-09 19:07:42 +100057
Ned Deily07a18922018-01-31 18:12:38 -050058
59Summary -- Release highlights
60=============================
61
62.. This section singles out the most important changes in Python 3.8.
63 Brevity is key.
64
65
66.. PEP-sized items next.
67
68
69
70New Features
71============
72
Guido van Rossum09d434c2019-04-24 11:30:17 -070073Assignment expressions
74----------------------
75
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070076There is new syntax ``:=`` that assigns values to variables as part of a larger
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -040077expression. It is affectionately known as "the walrus operator" due to
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070078its resemblance to `the eyes and tusks of a walrus
79<https://en.wikipedia.org/wiki/Walrus#/media/File:Pacific_Walrus_-_Bull_(8247646168).jpg>`_.
80
81In this example, the assignment expression helps avoid calling
82:func:`len` twice::
Guido van Rossum09d434c2019-04-24 11:30:17 -070083
84 if (n := len(a)) > 10:
85 print(f"List is too long ({n} elements, expected <= 10)")
86
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -070087A similar benefit arises during regular expression matching where
88match objects are needed twice, once to test whether a match
89occurred and another to extract a subgroup::
90
91 discount = 0.0
92 if (mo := re.search(r'(\d+)% discount', advertisement)):
93 discount = float(mo.group(1)) / 100.0
94
95The operator is also useful with while-loops that compute
96a value to test loop termination and then need that same
97value again in the body of the loop::
98
99 # Loop over fixed length blocks
100 while (block := f.read(256)) != '':
101 process(block)
102
103Another motivating use case arises in list comprehensions where
104a value computed in a filtering condition is also needed in
105the expression body::
106
107 [clean_name.title() for name in names
108 if (clean_name := normalize('NFC', name)) in allowed_names]
109
110Try to limit use of the walrus operator to clean cases that reduce
111complexity and improve readability.
112
Guido van Rossum09d434c2019-04-24 11:30:17 -0700113See :pep:`572` for a full description.
114
115(Contributed by Emily Morehouse in :issue:`35224`.)
116
Guido van Rossum09d434c2019-04-24 11:30:17 -0700117
Guido van Rossum843bf422019-04-29 05:49:30 -0700118Positional-only parameters
119--------------------------
120
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700121There is a new function parameter syntax ``/`` to indicate that some
122function parameters must be specified positionally and cannot be used as
123keyword arguments. This is the same notation shown by ``help()`` for C
124functions annotated with Larry Hastings' `Argument Clinic
125<https://docs.python.org/3/howto/clinic.html>`_ tool.
126
127In the following example, parameters *a* and *b* are positional-only,
128while *c* or *d* can be positional or keyword, and *e* or *f* are
129required to be keywords::
130
131 def f(a, b, /, c, d, *, e, f):
132 print(a, b, c, d, e, f)
133
134The following is a valid call::
135
136 f(10, 20, 30, d=40, e=50, f=60)
137
138However, these are invalid calls::
139
140 f(10, b=20, c=30, d=40, e=50, f=60) # b cannot be a keyword argument
141 f(10, 20, 30, 40, 50, f=60) # e must be a keyword argument
142
143One use case for this notation is that it allows pure Python functions
144to fully emulate behaviors of existing C coded functions. For example,
145the built-in :func:`pow` function does not accept keyword arguments::
Guido van Rossum843bf422019-04-29 05:49:30 -0700146
147 def pow(x, y, z=None, /):
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700148 "Emulate the built in pow() function"
149 r = x ** y
150 return r if z is None else r%z
Guido van Rossum843bf422019-04-29 05:49:30 -0700151
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700152Another use case is to preclude keyword arguments when the parameter
153name is not helpful. For example, the builtin :func:`len` function has
154the signature ``len(obj, /)``. This precludes awkward calls such as::
155
156 len(obj='hello') # The "obj" keyword argument impairs readability
157
158A further benefit of marking a parameter as positional-only is that it
159allows the parameter name to be changed in the future without risk of
160breaking client code. For example, in the :mod:`statistics` module, the
161parameter name *dist* may be changed in the future. This was made
162possible with the following function specification::
163
164 def quantiles(dist, /, *, n=4, method='exclusive')
165 ...
166
167Since the parameters to the left of ``/`` are not exposed as possible
168keywords, the parameters names remain available for use in ``**kwargs``::
169
170 >>> def f(a, b, /, **kwargs):
171 ... print(a, b, kwargs)
172 ...
173 >>> f(10, 20, a=1, b=2, c=3) # a and b are used in two ways
174 10 20 {'a': 1, 'b': 2, 'c': 3}
175
176This greatly simplifies the implementation of functions and methods
177that need to accept arbitrary keyword arguments. For example, here
Hugo van Kemenade547c60c2019-10-12 20:53:36 +0300178is an excerpt from code in the :mod:`collections` module::
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700179
180 class Counter(dict):
181
182 def __init__(self, iterable=None, /, **kwds):
183 # Note "iterable" is a possible keyword argument
Guido van Rossum843bf422019-04-29 05:49:30 -0700184
185See :pep:`570` for a full description.
186
187(Contributed by Pablo Galindo in :issue:`36540`.)
188
189.. TODO: Pablo will sprint on docs at PyCon US 2019.
190
191
Nick Coghlan16eb3bc2018-06-20 21:25:01 +1000192Parallel filesystem cache for compiled bytecode files
193-----------------------------------------------------
194
195The new :envvar:`PYTHONPYCACHEPREFIX` setting (also available as
196:option:`-X` ``pycache_prefix``) configures the implicit bytecode
197cache to use a separate parallel filesystem tree, rather than
198the default ``__pycache__`` subdirectories within each source
199directory.
200
201The location of the cache is reported in :data:`sys.pycache_prefix`
202(:const:`None` indicates the default location in ``__pycache__``
203subdirectories).
204
205(Contributed by Carl Meyer in :issue:`33499`.)
Ned Deily07a18922018-01-31 18:12:38 -0500206
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300207
Victor Stinner40460692019-04-26 17:56:44 +0200208Debug build uses the same ABI as release build
209-----------------------------------------------
210
Hugo van Kemenade547c60c2019-10-12 20:53:36 +0300211Python now uses the same ABI whether it's built in release or debug mode. On
Paul Ganssle5c403b22019-04-27 14:14:35 -0400212Unix, when Python is built in debug mode, it is now possible to load C
213extensions built in release mode and C extensions built using the stable ABI.
Victor Stinner40460692019-04-26 17:56:44 +0200214
Paul Ganssle5c403b22019-04-27 14:14:35 -0400215Release builds and debug builds are now ABI compatible: defining the
216``Py_DEBUG`` macro no longer implies the ``Py_TRACE_REFS`` macro, which
217introduces the only ABI incompatibility. The ``Py_TRACE_REFS`` macro, which
218adds the :func:`sys.getobjects` function and the :envvar:`PYTHONDUMPREFS`
219environment variable, can be set using the new ``./configure --with-trace-refs``
220build option.
Victor Stinner40460692019-04-26 17:56:44 +0200221(Contributed by Victor Stinner in :issue:`36465`.)
222
E. M. Brayc994c8f2019-05-24 17:33:47 +0200223On Unix, C extensions are no longer linked to libpython except on Android
224and Cygwin.
Victor Stinner4ebcd7e2019-05-11 04:10:03 +0200225It is now possible
Paul Ganssle5c403b22019-04-27 14:14:35 -0400226for a statically linked Python to load a C extension built using a shared
227library Python.
Victor Stinner40460692019-04-26 17:56:44 +0200228(Contributed by Victor Stinner in :issue:`21536`.)
229
230On Unix, when Python is built in debug mode, import now also looks for C
231extensions compiled in release mode and for C extensions compiled with the
232stable ABI.
233(Contributed by Victor Stinner in :issue:`36722`.)
234
Victor Stinner0a8e5722019-05-23 03:30:23 +0200235To embed Python into an application, a new ``--embed`` option must be passed to
236``python3-config --libs --embed`` to get ``-lpython3.8`` (link the application
237to libpython). To support both 3.8 and older, try ``python3-config --libs
238--embed`` first and fallback to ``python3-config --libs`` (without ``--embed``)
239if the previous command fails.
240
241Add a pkg-config ``python-3.8-embed`` module to embed Python into an
242application: ``pkg-config python-3.8-embed --libs`` includes ``-lpython3.8``.
243To support both 3.8 and older, try ``pkg-config python-X.Y-embed --libs`` first
244and fallback to ``pkg-config python-X.Y --libs`` (without ``--embed``) if the
245previous command fails (replace ``X.Y`` with the Python version).
246
247On the other hand, ``pkg-config python3.8 --libs`` no longer contains
248``-lpython3.8``. C extensions must not be linked to libpython (except on
E. M. Brayc994c8f2019-05-24 17:33:47 +0200249Android and Cygwin, whose cases are handled by the script);
250this change is backward incompatible on purpose.
Victor Stinner0a8e5722019-05-23 03:30:23 +0200251(Contributed by Victor Stinner in :issue:`36721`.)
252
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400253
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700254f-strings support ``=`` for self-documenting expressions and debugging
255----------------------------------------------------------------------
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400256
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700257Added an ``=`` specifier to :term:`f-string`\s. An f-string such as
258``f'{expr=}'`` will expand to the text of the expression, an equal sign,
259then the representation of the evaluated expression. For example:
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400260
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700261 >>> user = 'eric_idle'
262 >>> member_since = date(1975, 7, 31)
263 >>> f'{user=} {member_since=}'
264 "user='eric_idle' member_since=datetime.date(1975, 7, 31)"
265
266The usual :ref:`f-string format specifiers <f-strings>` allow more
267control over how the result of the expression is displayed::
268
269 >>> delta = date.today() - member_since
270 >>> f'{user=!s} {delta.days=:,d}'
271 'user=eric_idle delta.days=16,075'
272
273The ``=`` specifier will display the whole expression so that
274calculations can be shown::
275
276 >>> print(f'{theta=} {cos(radians(theta))=:.3f}')
277 theta=30 cos(radians(theta))=0.866
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400278
279(Contributed by Eric V. Smith and Larry Hastings in :issue:`36817`.)
280
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300281
Raymond Hettinger274bd012019-10-14 09:01:05 -0700282PEP 578: Python Runtime Audit Hooks
283-----------------------------------
284
285The PEP adds an Audit Hook and Verified Open Hook. Both are available from
286Python and native code, allowing applications and frameworks written in pure
287Python code to take advantage of extra notifications, while also allowing
288embedders or system administrators to deploy builds of Python where auditing is
289always enabled.
290
291See :pep:`578` for full details.
292
293
Victor Stinner331a6a52019-05-27 16:39:22 +0200294PEP 587: Python Initialization Configuration
295--------------------------------------------
296
297The :pep:`587` adds a new C API to configure the Python Initialization
298providing finer control on the whole configuration and better error reporting.
299
300New structures:
301
302* :c:type:`PyConfig`
303* :c:type:`PyPreConfig`
304* :c:type:`PyStatus`
305* :c:type:`PyWideStringList`
306
307New functions:
308
309* :c:func:`PyConfig_Clear`
310* :c:func:`PyConfig_InitIsolatedConfig`
311* :c:func:`PyConfig_InitPythonConfig`
312* :c:func:`PyConfig_Read`
313* :c:func:`PyConfig_SetArgv`
314* :c:func:`PyConfig_SetBytesArgv`
315* :c:func:`PyConfig_SetBytesString`
316* :c:func:`PyConfig_SetString`
317* :c:func:`PyPreConfig_InitIsolatedConfig`
318* :c:func:`PyPreConfig_InitPythonConfig`
319* :c:func:`PyStatus_Error`
320* :c:func:`PyStatus_Exception`
321* :c:func:`PyStatus_Exit`
322* :c:func:`PyStatus_IsError`
323* :c:func:`PyStatus_IsExit`
324* :c:func:`PyStatus_NoMemory`
325* :c:func:`PyStatus_Ok`
326* :c:func:`PyWideStringList_Append`
327* :c:func:`PyWideStringList_Insert`
328* :c:func:`Py_BytesMain`
329* :c:func:`Py_ExitStatusException`
330* :c:func:`Py_InitializeFromConfig`
331* :c:func:`Py_PreInitialize`
332* :c:func:`Py_PreInitializeFromArgs`
333* :c:func:`Py_PreInitializeFromBytesArgs`
334* :c:func:`Py_RunMain`
335
336This PEP also adds ``_PyRuntimeState.preconfig`` (:c:type:`PyPreConfig` type)
337and ``PyInterpreterState.config`` (:c:type:`PyConfig` type) fields to these
338internal structures. ``PyInterpreterState.config`` becomes the new
339reference configuration, replacing global configuration variables and
340other private variables.
341
342See :ref:`Python Initialization Configuration <init-config>` for the
343documentation.
344
345See :pep:`587` for a full description.
346
347(Contributed by Victor Stinner in :issue:`36763`.)
348
Ned Deily07a18922018-01-31 18:12:38 -0500349
Jeroen Demeyer9a13a382019-11-12 14:08:00 +0100350PEP 590: Vectorcall: a fast calling protocol for CPython
351--------------------------------------------------------
Jeroen Demeyer9e3e06e2019-06-03 01:43:13 +0200352
Jeroen Demeyer9a13a382019-11-12 14:08:00 +0100353:ref:`vectorcall` is added to the Python/C API.
Jeroen Demeyer9e3e06e2019-06-03 01:43:13 +0200354It is meant to formalize existing optimizations which were already done
355for various classes.
Jeroen Demeyer9a13a382019-11-12 14:08:00 +0100356Any static type implementing a callable can use this protocol.
Jeroen Demeyer9e3e06e2019-06-03 01:43:13 +0200357
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700358This is currently provisional.
359The aim is to make it fully public in Python 3.9.
Jeroen Demeyer9e3e06e2019-06-03 01:43:13 +0200360
361See :pep:`590` for a full description.
362
Jeroen Demeyer9a13a382019-11-12 14:08:00 +0100363(Contributed by Jeroen Demeyer, Mark Shannon and Petr Viktorin in :issue:`36974`.)
Jeroen Demeyer9e3e06e2019-06-03 01:43:13 +0200364
365
Antoine Pitrouc879ff22019-06-09 14:47:15 +0200366Pickle protocol 5 with out-of-band data buffers
367-----------------------------------------------
368
369When :mod:`pickle` is used to transfer large data between Python processes
370in order to take advantage of multi-core or multi-machine processing,
371it is important to optimize the transfer by reducing memory copies, and
372possibly by applying custom techniques such as data-dependent compression.
373
374The :mod:`pickle` protocol 5 introduces support for out-of-band buffers
375where :pep:`3118`-compatible data can be transmitted separately from the
376main pickle stream, at the discretion of the communication layer.
377
378See :pep:`574` for a full description.
379
380(Contributed by Antoine Pitrou in :issue:`36785`.)
381
382
Ned Deily07a18922018-01-31 18:12:38 -0500383Other Language Changes
384======================
385
Serhiy Storchakafe2bbb12018-03-18 09:56:52 +0200386* A :keyword:`continue` statement was illegal in the :keyword:`finally` clause
387 due to a problem with the implementation. In Python 3.8 this restriction
388 was lifted.
389 (Contributed by Serhiy Storchaka in :issue:`32489`.)
390
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700391* The :class:`bool`, :class:`int`, and :class:`fractions.Fraction` types
392 now have an :meth:`~int.as_integer_ratio` method like that found in
393 :class:`float` and :class:`decimal.Decimal`. This minor API extension
394 makes it possible to write ``numerator, denominator =
395 x.as_integer_ratio()`` and have it work across multiple numeric types.
396 (Contributed by Lisa Roach in :issue:`33073` and Raymond Hettinger in
397 :issue:`37819`.)
Lisa Roach5ac70432018-09-13 23:56:23 -0700398
Serhiy Storchakabdbad712019-06-02 00:05:48 +0300399* Constructors of :class:`int`, :class:`float` and :class:`complex` will now
400 use the :meth:`~object.__index__` special method, if available and the
401 corresponding method :meth:`~object.__int__`, :meth:`~object.__float__`
402 or :meth:`~object.__complex__` is not available.
403 (Contributed by Serhiy Storchaka in :issue:`20092`.)
404
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700405* Added support of ``\N{name}`` escapes in :mod:`regular expressions <re>`::
406
407 >>> notice = 'Copyright © 2019'
408 >>> copyright_year_pattern = re.compile(r'\N{copyright sign}\s*(\d{4})')
409 >>> int(copyright_year_pattern.search(notice).group(1))
410 2019
411
Serhiy Storchakaa445feb2018-02-10 00:08:17 +0200412 (Contributed by Jonathan Eunice and Serhiy Storchaka in :issue:`30688`.)
Ned Deily07a18922018-01-31 18:12:38 -0500413
Rémi Lapeyre6531bf62018-11-06 01:38:54 +0100414* Dict and dictviews are now iterable in reversed insertion order using
415 :func:`reversed`. (Contributed by Rémi Lapeyre in :issue:`33462`.)
416
Benjamin Petersonc9a71dd2018-09-12 17:14:39 -0700417* The syntax allowed for keyword names in function calls was further
418 restricted. In particular, ``f((keyword)=arg)`` is no longer allowed. It was
419 never intended to permit more than a bare name on the left-hand side of a
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300420 keyword argument assignment term.
421 (Contributed by Benjamin Peterson in :issue:`34641`.)
Ned Deily07a18922018-01-31 18:12:38 -0500422
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700423* Generalized iterable unpacking in :keyword:`yield` and
424 :keyword:`return` statements no longer requires enclosing parentheses.
425 This brings the *yield* and *return* syntax into better agreement with
426 normal assignment syntax::
427
428 >>> def parse(family):
429 lastname, *members = family.split()
430 return lastname.upper(), *members
431
432 >>> parse('simpsons homer marge bart lisa sally')
433 ('SIMPSONS', 'homer', 'marge', 'bart', 'lisa', 'sally')
434
jChapman8fabae32018-09-22 21:13:10 -0400435 (Contributed by David Cuthbert and Jordan Chapman in :issue:`32117`.)
436
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700437* When a comma is missed in code such as ``[(10, 20) (30, 40)]``, the
438 compiler displays a :exc:`SyntaxWarning` with a helpful suggestion.
439 This improves on just having a :exc:`TypeError` indicating that the
440 first tuple was not callable. (Contributed by Serhiy Storchaka in
441 :issue:`15248`.)
Serhiy Storchaka62e44812019-02-16 08:12:19 +0200442
Paul Ganssled9503c32019-02-08 11:02:00 -0500443* Arithmetic operations between subclasses of :class:`datetime.date` or
444 :class:`datetime.datetime` and :class:`datetime.timedelta` objects now return
445 an instance of the subclass, rather than the base class. This also affects
446 the return type of operations whose implementation (directly or indirectly)
447 uses :class:`datetime.timedelta` arithmetic, such as
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700448 :meth:`~datetime.datetime.astimezone`.
Paul Ganssled9503c32019-02-08 11:02:00 -0500449 (Contributed by Paul Ganssle in :issue:`32417`.)
450
Gregory P. Smith06babb22019-02-23 10:43:49 -0800451* When the Python interpreter is interrupted by Ctrl-C (SIGINT) and the
452 resulting :exc:`KeyboardInterrupt` exception is not caught, the Python process
453 now exits via a SIGINT signal or with the correct exit code such that the
454 calling process can detect that it died due to a Ctrl-C. Shells on POSIX
455 and Windows use this to properly terminate scripts in interactive sessions.
456 (Contributed by Google via Gregory P. Smith in :issue:`1054041`.)
457
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700458* Some advanced styles of programming require updating the
459 :class:`types.CodeType` object for an existing function. Since code
460 objects are immutable, a new code object needs to be created, one
461 that is modeled on the existing code object. With 19 parameters,
462 this was somewhat tedious. Now, the new ``replace()`` method makes
463 it possible to create a clone with a few altered parameters.
464
465 Here's an example that alters the :func:`statistics.mean` function to
466 prevent the *data* parameter from being used as a keyword argument::
467
468 >>> from statistics import mean
469 >>> mean(data=[10, 20, 90])
470 40
471 >>> mean.__code__ = mean.__code__.replace(co_posonlyargcount=1)
472 >>> mean(data=[10, 20, 90])
473 Traceback (most recent call last):
474 ...
475 TypeError: mean() got some positional-only arguments passed as keyword arguments: 'data'
476
Victor Stinnera9f05d62019-05-24 23:57:23 +0200477 (Contributed by Victor Stinner in :issue:`37032`.)
478
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700479* For integers, the three-argument form of the :func:`pow` function now
480 permits the exponent to be negative in the case where the base is
481 relatively prime to the modulus. It then computes a modular inverse to
482 the base when the exponent is ``-1``, and a suitable power of that
483 inverse for other negative exponents. For example, to compute the
484 `modular multiplicative inverse
485 <https://en.wikipedia.org/wiki/Modular_multiplicative_inverse>`_ of 38
486 modulo 137, write::
487
488 >>> pow(38, -1, 137)
489 119
490 >>> 119 * 38 % 137
491 1
492
493 Modular inverses arise in the solution of `linear Diophantine
494 equations <https://en.wikipedia.org/wiki/Diophantine_equation>`_.
495 For example, to find integer solutions for ``4258𝑥 + 147𝑦 = 369``,
496 first rewrite as ``4258𝑥 ≡ 369 (mod 147)`` then solve:
497
498 >>> x = 369 * pow(4258, -1, 147) % 147
499 >>> y = (4258 * x - 369) // -147
500 >>> 4258 * x + 147 * y
501 369
502
Mark Dickinsonc5299672019-06-02 10:24:06 +0100503 (Contributed by Mark Dickinson in :issue:`36027`.)
504
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700505* Dict comprehensions have been synced-up with dict literals so that the
506 key is computed first and the value second::
507
508 >>> # Dict comprehension
509 >>> cast = {input('role? '): input('actor? ') for i in range(2)}
510 role? King Arthur
511 actor? Chapman
512 role? Black Knight
513 actor? Cleese
514
515 >>> # Dict literal
516 >>> cast = {input('role? '): input('actor? ')}
517 role? Sir Robin
518 actor? Eric Idle
519
520 The guaranteed execution order is helpful with assignment expressions
521 because variables assigned in the key expression will be available in
522 the value expression::
523
524 >>> names = ['Martin von Löwis', 'Łukasz Langa', 'Walter Dörwald']
525 >>> {(n := normalize('NFC', name)).casefold() : n for name in names}
526 {'martin von löwis': 'Martin von Löwis',
527 'łukasz langa': 'Łukasz Langa',
528 'walter dörwald': 'Walter Dörwald'}
Pablo Galindob51b7132019-06-25 02:41:58 +0100529
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300530 (Contributed by Jörn Heissler in :issue:`35224`.)
531
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700532* The :meth:`object.__reduce__` method can now return a tuple from two to
533 six elements long. Formerly, five was the limit. The new, optional sixth
534 element is a callable with a ``(obj, state)`` signature. This allows the
535 direct control over the state-updating behavior of a specific object. If
536 not *None*, this callable will have priority over the object's
537 :meth:`~__setstate__` method.
538 (Contributed by Pierre Glaser and Olivier Grisel in :issue:`35900`.)
Serhiy Storchaka65439122018-10-19 17:42:06 +0300539
Ned Deily07a18922018-01-31 18:12:38 -0500540New Modules
541===========
542
Barry Warsaw4867eaa2019-06-05 19:40:19 -0700543* The new :mod:`importlib.metadata` module provides (provisional) support for
Raymond Hettinger66a34d32019-08-12 15:55:18 -0700544 reading metadata from third-party packages. For example, it can extract an
545 installed package's version number, list of entry points, and more::
546
547 >>> # Note following example requires that the popular "requests"
548 >>> # package has been installed.
549 >>>
550 >>> from importlib.metadata import version, requires, files
551 >>> version('requests')
552 '2.22.0'
553 >>> list(requires('requests'))
554 ['chardet (<3.1.0,>=3.0.2)']
555 >>> list(files('requests'))[:5]
556 [PackagePath('requests-2.22.0.dist-info/INSTALLER'),
557 PackagePath('requests-2.22.0.dist-info/LICENSE'),
558 PackagePath('requests-2.22.0.dist-info/METADATA'),
559 PackagePath('requests-2.22.0.dist-info/RECORD'),
560 PackagePath('requests-2.22.0.dist-info/WHEEL')]
561
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300562 (Contributed by Barry Warsaw and Jason R. Coombs in :issue:`34632`.)
Ned Deily07a18922018-01-31 18:12:38 -0500563
564
565Improved Modules
566================
567
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700568ast
569---
570
571AST nodes now have ``end_lineno`` and ``end_col_offset`` attributes,
572which give the precise location of the end of the node. (This only
573applies to nodes that have ``lineno`` and ``col_offset`` attributes.)
574
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300575New function :func:`ast.get_source_segment` returns the source code
576for a specific AST node.
577
578(Contributed by Ivan Levkivskyi in :issue:`33416`.)
579
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700580The :func:`ast.parse` function has some new flags:
581
582* ``type_comments=True`` causes it to return the text of :pep:`484` and
583 :pep:`526` type comments associated with certain AST nodes;
584
585* ``mode='func_type'`` can be used to parse :pep:`484` "signature type
586 comments" (returned for function definition AST nodes);
587
Guido van Rossum10b55c12019-06-11 17:23:12 -0700588* ``feature_version=(3, N)`` allows specifying an earlier Python 3
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700589 version. For example, ``feature_version=(3, 4)`` will treat
590 :keyword:`async` and :keyword:`await` as non-reserved words.
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700591
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300592(Contributed by Guido van Rossum in :issue:`35766`.)
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700593
594
Victor Stinner6ea29c52018-09-25 08:27:08 -0700595asyncio
596-------
597
Kyle Stanley3bbb6db2019-10-24 00:15:25 -0400598:func:`asyncio.run` has graduated from the provisional to stable API. This
599function can be used to execute a :term:`coroutine` and return the result while
600automatically managing the event loop. For example::
601
602 import asyncio
603
604 async def main():
605 await asyncio.sleep(0)
606 return 42
607
608 asyncio.run(main())
609
610This is *roughly* equivalent to::
611
612 import asyncio
613
614 async def main():
615 await asyncio.sleep(0)
616 return 42
617
618 loop = asyncio.new_event_loop()
619 asyncio.set_event_loop(loop)
620 try:
621 loop.run_until_complete(main())
622 finally:
623 asyncio.set_event_loop(None)
624 loop.close()
625
626
627The actual implementation is significantly more complex. Thus,
628:func:`asyncio.run` should be the preferred way of running asyncio programs.
629
630(Contributed by Yury Selivanov in :issue:`32314`.)
631
Raymond Hettinger274bd012019-10-14 09:01:05 -0700632Running ``python -m asyncio`` launches a natively async REPL. This allows rapid
633experimentation with code that has a top-level :keyword:`await`. There is no
634longer a need to directly call ``asyncio.run()`` which would spawn a new event
635loop on every invocation:
636
637.. code-block:: none
638
639 $ python -m asyncio
640 asyncio REPL 3.8.0
641 Use "await" directly instead of "asyncio.run()".
642 Type "help", "copyright", "credits" or "license" for more information.
643 >>> import asyncio
644 >>> await asyncio.sleep(10, result='hello')
645 hello
646
647(Contributed by Yury Selivanov in :issue:`37028`.)
648
Kyle Stanley3bbb6db2019-10-24 00:15:25 -0400649The exception :class:`asyncio.CancelledError` now inherits from
650:class:`BaseException` rather than :class:`Exception`.
651(Contributed by Yury Selivanov in :issue:`32528`.)
652
Victor Stinner6ea29c52018-09-25 08:27:08 -0700653On Windows, the default event loop is now :class:`~asyncio.ProactorEventLoop`.
Victor Stinner01ae8972019-06-03 16:28:01 +0200654(Contributed by Victor Stinner in :issue:`34687`.)
655
656:class:`~asyncio.ProactorEventLoop` now also supports UDP.
657(Contributed by Adam Meily and Andrew Svetlov in :issue:`29883`.)
658
659:class:`~asyncio.ProactorEventLoop` can now be interrupted by
660:exc:`KeyboardInterrupt` ("CTRL+C").
661(Contributed by Vladimir Matveev in :issue:`23057`.)
662
Kyle Stanley3bbb6db2019-10-24 00:15:25 -0400663Added :meth:`asyncio.Task.get_coro` for getting the wrapped coroutine
664within an :class:`asyncio.Task`.
665(Contributed by Alex Grönholm in :issue:`36999`.)
666
667Asyncio tasks can now be named, either by passing the ``name`` keyword
668argument to :func:`asyncio.create_task` or
669the :meth:`~asyncio.loop.create_task` event loop method, or by
670calling the :meth:`~asyncio.Task.set_name` method on the task object. The
671task name is visible in the ``repr()`` output of :class:`asyncio.Task` and
672can also be retrieved using the :meth:`~asyncio.Task.get_name` method.
673(Contributed by Alex Grönholm in :issue:`34270`.)
674
675Added support for
676`Happy Eyeballs <https://en.wikipedia.org/wiki/Happy_Eyeballs>`_ to
677:func:`asyncio.loop.create_connection`. To specify the behavior, two new
678parameters have been added: *happy_eyeballs_delay* and *interleave*. The Happy
679Eyeballs algorithm improves responsiveness in applications that support IPv4
680and IPv6 by attempting to simultaneously connect using both.
681(Contributed by twisteroid ambassador in :issue:`33530`.)
682
Victor Stinner6ea29c52018-09-25 08:27:08 -0700683
Matthias Bussonnier2ddbd212019-05-22 12:07:45 -0700684builtins
685--------
686
687The :func:`compile` built-in has been improved to accept the
688``ast.PyCF_ALLOW_TOP_LEVEL_AWAIT`` flag. With this new flag passed,
689:func:`compile` will allow top-level ``await``, ``async for`` and ``async with``
690constructs that are usually considered invalid syntax. Asynchronous code object
691marked with the ``CO_COROUTINE`` flag may then be returned.
Matthias Bussonnier2ddbd212019-05-22 12:07:45 -0700692(Contributed by Matthias Bussonnier in :issue:`34616`)
Terry Jan Reedyfdcb5ae2018-09-25 12:45:27 -0400693
Raymond Hettinger61a6db52019-10-13 21:31:12 -0700694
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700695collections
696-----------
697
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700698The :meth:`~collections.somenamedtuple._asdict` method for
699:func:`collections.namedtuple` now returns a :class:`dict` instead of a
700:class:`collections.OrderedDict`. This works because regular dicts have
701guaranteed ordering since Python 3.7. If the extra features of
702:class:`OrderedDict` are required, the suggested remediation is to cast the
703result to the desired type: ``OrderedDict(nt._asdict())``.
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700704(Contributed by Raymond Hettinger in :issue:`35864`.)
705
706
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700707cProfile
708--------
709
710The :class:`cProfile.Profile <profile.Profile>` class can now be used as a context manager.
711Profile a block of code by running::
712
713 import cProfile
714
715 with cProfile.Profile() as profiler:
716 # code to be profiled
717 ...
718
719(Contributed by Scott Sanderson in :issue:`29235`.)
720
721
722csv
723---
724
725The :class:`csv.DictReader` now returns instances of :class:`dict` instead of
726a :class:`collections.OrderedDict`. The tool is now faster and uses less
727memory while still preserving the field order.
728(Contributed by Michael Seek in :issue:`34003`.)
729
730
Raymond Hettinger61a6db52019-10-13 21:31:12 -0700731curses
732-------
733
734Added a new variable holding structured version information for the
735underlying ncurses library: :data:`~curses.ncurses_version`.
736(Contributed by Serhiy Storchaka in :issue:`31680`.)
737
738
Steve Dower2438cdf2019-03-29 16:37:16 -0700739ctypes
740------
741
742On Windows, :class:`~ctypes.CDLL` and subclasses now accept a *winmode* parameter
743to specify flags for the underlying ``LoadLibraryEx`` call. The default flags are
744set to only load DLL dependencies from trusted locations, including the path
745where the DLL is stored (if a full or partial path is used to load the initial
746DLL) and paths added by :func:`~os.add_dll_directory`.
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300747(Contributed by Steve Dower in :issue:`36085`.)
Steve Dower2438cdf2019-03-29 16:37:16 -0700748
749
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -0400750datetime
751--------
752
753Added new alternate constructors :meth:`datetime.date.fromisocalendar` and
754:meth:`datetime.datetime.fromisocalendar`, which construct :class:`date` and
755:class:`datetime` objects respectively from ISO year, week number, and weekday;
756these are the inverse of each class's ``isocalendar`` method.
757(Contributed by Paul Ganssle in :issue:`36004`.)
758
759
Raymond Hettingerb8218682019-05-26 11:27:35 -0700760functools
761---------
762
763:func:`functools.lru_cache` can now be used as a straight decorator rather
764than as a function returning a decorator. So both of these are now supported::
765
766 @lru_cache
767 def f(x):
768 ...
769
770 @lru_cache(maxsize=256)
771 def f(x):
772 ...
773
774(Contributed by Raymond Hettinger in :issue:`36772`.)
775
Stéphane Wirtel93b81e12019-10-18 09:14:18 +0200776Added a new :func:`functools.cached_property` decorator, for computed properties
777cached for the life of the instance. ::
778
779 import functools
780 import statistics
781
782 class Dataset:
783 def __init__(self, sequence_of_numbers):
784 self.data = sequence_of_numbers
785
786 @functools.cached_property
787 def variance(self):
788 return statistics.variance(self.data)
789
790(Contributed by Carl Meyer in :issue:`21145`)
791
Raymond Hettingerb8218682019-05-26 11:27:35 -0700792
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700793Added a new :func:`functools.singledispatchmethod` decorator that converts
794methods into :term:`generic functions <generic function>` using
795:term:`single dispatch`::
796
797 from functools import singledispatchmethod
798 from contextlib import suppress
799
800 class TaskManager:
801
802 def __init__(self, tasks):
803 self.tasks = list(tasks)
804
805 @singledispatchmethod
806 def discard(self, value):
807 with suppress(ValueError):
808 self.tasks.remove(value)
809
810 @discard.register(list)
811 def _(self, tasks):
812 targets = set(tasks)
813 self.tasks = [x for x in self.tasks if x not in targets]
814
815(Contributed by Ethan Smith in :issue:`32380`)
816
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -0400817gc
818--
Paul Ganssle88c09372019-04-29 09:22:03 -0400819
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -0400820:func:`~gc.get_objects` can now receive an optional *generation* parameter
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300821indicating a generation to get objects from.
822(Contributed by Pablo Galindo in :issue:`36016`.)
Paul Ganssle88c09372019-04-29 09:22:03 -0400823
824
Cheryl Sabella637a33b2018-11-07 09:12:20 -0500825gettext
826-------
827
828Added :func:`~gettext.pgettext` and its variants.
829(Contributed by Franz Glasner, Éric Araujo, and Cheryl Sabella in :issue:`2504`.)
830
Terry Jan Reedya72ca902019-07-31 01:03:53 -0400831
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -0400832gzip
833----
834
835Added the *mtime* parameter to :func:`gzip.compress` for reproducible output.
836(Contributed by Guo Ci Teo in :issue:`34898`.)
837
838A :exc:`~gzip.BadGzipFile` exception is now raised instead of :exc:`OSError`
839for certain types of invalid or corrupt gzip files.
840(Contributed by Filip Gruszczyński, Michele Orrù, and Zackery Spytz in
841:issue:`6584`.)
842
843
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700844IDLE and idlelib
Terry Jan Reedya72ca902019-07-31 01:03:53 -0400845----------------
846
847Output over N lines (50 by default) is squeezed down to a button.
848N can be changed in the PyShell section of the General page of the
849Settings dialog. Fewer, but possibly extra long, lines can be squeezed by
850right clicking on the output. Squeezed output can be expanded in place
851by double-clicking the button or into the clipboard or a separate window
852by right-clicking the button. (Contributed by Tal Einat in :issue:`1529353`.)
853
854Add "Run Customized" to the Run menu to run a module with customized
855settings. Any command line arguments entered are added to sys.argv.
856They also re-appear in the box for the next customized run. One can also
857suppress the normal Shell main module restart. (Contributed by Cheryl
858Sabella, Terry Jan Reedy, and others in :issue:`5680` and :issue:`37627`.)
859
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700860Added optional line numbers for IDLE editor windows. Windows
Terry Jan Reedya72ca902019-07-31 01:03:53 -0400861open without line numbers unless set otherwise in the General
862tab of the configuration dialog. Line numbers for an existing
863window are shown and hidden in the Options menu.
864(Contributed by Tal Einat and Saimadhav Heblikar in :issue:`17535`.)
865
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700866OS native encoding is now used for converting between Python strings and Tcl
867objects. This allows IDLE to work with emoji and other non-BMP characters.
868These characters can be displayed or copied and pasted to or from the
869clipboard. Converting strings from Tcl to Python and back now never fails.
870(Many people worked on this for eight years but the problem was finally
871solved by Serhiy Storchaka in :issue:`13153`.)
872
Terry Jan Reedya72ca902019-07-31 01:03:53 -0400873The changes above have been backported to 3.7 maintenance releases.
874
875
Raymond Hettingerd1e768a2019-03-25 13:01:13 -0700876inspect
877-------
878
879The :func:`inspect.getdoc` function can now find docstrings for ``__slots__``
880if that attribute is a :class:`dict` where the values are docstrings.
881This provides documentation options similar to what we already have
882for :func:`property`, :func:`classmethod`, and :func:`staticmethod`::
883
884 class AudioClip:
885 __slots__ = {'bit_rate': 'expressed in kilohertz to one decimal place',
886 'duration': 'in seconds, rounded up to an integer'}
887 def __init__(self, bit_rate, duration):
888 self.bit_rate = round(bit_rate / 1000.0, 1)
889 self.duration = ceil(duration)
Pablo Galindo175421b2019-02-23 03:02:06 +0000890
Serhiy Storchaka298439c2019-10-14 16:10:40 +0300891(Contributed by Raymond Hettinger in :issue:`36326`.)
892
Terry Jan Reedya72ca902019-07-31 01:03:53 -0400893
Victor Stinnerbc2aa812019-05-23 03:45:09 +0200894io
895--
896
897In development mode (:option:`-X` ``env``) and in debug build, the
898:class:`io.IOBase` finalizer now logs the exception if the ``close()`` method
899fails. The exception is ignored silently by default in release build.
900(Contributed by Victor Stinner in :issue:`18748`.)
901
902
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700903itertools
904---------
905
906The :func:`itertools.accumulate` function added an option *initial* keyword
907argument to specify an initial value::
908
909 >>> from itertools import accumulate
910 >>> list(accumulate([10, 5, 30, 15], initial=1000))
911 [1000, 1010, 1015, 1045, 1060]
912
913(Contributed by Lisa Roach in :issue:`34659`.)
914
915
HongWeipengf1944792018-11-07 18:09:32 +0800916json.tool
917---------
918
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700919Add option ``--json-lines`` to parse every input line as a separate JSON object.
HongWeipengf1944792018-11-07 18:09:32 +0800920(Contributed by Weipeng Hong in :issue:`31553`.)
921
Pablo Galindobc098512019-02-07 07:04:02 +0000922
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700923logging
924-------
925
926Added a *force* keyword argument to :func:`logging.basicConfig()`
927When set to *True*, any existing handlers attached
928to the root logger are removed and closed before carrying out the
929configuration specified by the other arguments.
930
931This solves a long-standing problem. Once a logger or *basicConfig()* had
932been called, subsequent calls to *basicConfig()* were silently ignored.
933This made it difficult to update, experiment with, or teach the various
934logging configuration options using the interactive prompt or a Jupyter
935notebook.
936
937(Suggested by Raymond Hettinger, implemented by Dong-hee Na, and
938reviewed by Vinay Sajip in :issue:`33897`.)
939
940
Pablo Galindobc098512019-02-07 07:04:02 +0000941math
942----
943
Raymond Hettinger3ff59622019-02-16 11:00:42 -0800944Added new function :func:`math.dist` for computing Euclidean distance
945between two points. (Contributed by Raymond Hettinger in :issue:`33089`.)
946
947Expanded the :func:`math.hypot` function to handle multiple dimensions.
948Formerly, it only supported the 2-D case.
949(Contributed by Raymond Hettinger in :issue:`33089`.)
950
Pablo Galindobc098512019-02-07 07:04:02 +0000951Added new function, :func:`math.prod`, as analogous function to :func:`sum`
952that returns the product of a 'start' value (default: 1) times an iterable of
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700953numbers::
954
955 >>> prior = 0.8
956 >>> likelihoods = [0.625, 0.84, 0.30]
Ashwin Vishnu1a8de822019-09-09 14:42:27 +0200957 >>> math.prod(likelihoods, start=prior)
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -0700958 0.126
959
Jero Badob1fa72a2019-10-18 15:48:48 +0800960(Contributed by Pablo Galindo in :issue:`35606`.)
Pablo Galindobc098512019-02-07 07:04:02 +0000961
Raymond Hettingerc93883c2019-10-20 11:25:16 -0700962Added two new combinatoric functions :func:`math.perm` and :func:`math.comb`::
963
964 >>> math.perm(10, 3) # Permutations of 10 things taken 3 at a time
965 720
966 >>> math.comb(10, 3) # Combinations of 10 things taken 3 at a time
967 120
968
969(Contributed by Yash Aggarwal, Keller Fuchs, Serhiy Storchaka, and Raymond
970Hettinger in :issue:`37128`, :issue:`37178`, and :issue:`35431`.)
971
972Added a new function :func:`math.isqrt` for computing accurate integer square
973roots without conversion to floating point. The new function supports
974arbitrarily large integers. It is faster than ``floor(sqrt(n))`` but slower
975than :func:`math.sqrt`::
976
977 >>> r = 650320427
978 >>> s = r ** 2
979 >>> isqrt(s - 1) # correct
980 650320426
981 >>> floor(sqrt(s - 1)) # incorrect
982 650320427
983
Mark Dickinson73934b92019-05-18 12:29:50 +0100984(Contributed by Mark Dickinson in :issue:`36887`.)
985
Mark Dickinsona0adffb2019-06-01 12:21:53 +0100986The function :func:`math.factorial` no longer accepts arguments that are not
987int-like. (Contributed by Pablo Galindo in :issue:`33083`.)
988
Zackery Spytz02db6962019-05-27 10:48:17 -0600989
990mmap
991----
992
993The :class:`mmap.mmap` class now has an :meth:`~mmap.mmap.madvise` method to
994access the ``madvise()`` system call.
995(Contributed by Zackery Spytz in :issue:`32941`.)
996
997
Victor Stinner17a55882019-05-28 16:02:50 +0200998multiprocessing
999---------------
1000
1001Added new :mod:`multiprocessing.shared_memory` module.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001002(Contributed by Davin Potts in :issue:`35813`.)
Victor Stinner17a55882019-05-28 16:02:50 +02001003
1004On macOS, the *spawn* start method is now used by default.
1005(Contributed by Victor Stinner in :issue:`33725`.)
1006
1007
Steve Dower2438cdf2019-03-29 16:37:16 -07001008os
1009--
1010
1011Added new function :func:`~os.add_dll_directory` on Windows for providing
1012additional search paths for native dependencies when importing extension
1013modules or loading DLLs using :mod:`ctypes`.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001014(Contributed by Steve Dower in :issue:`36085`.)
Steve Dower2438cdf2019-03-29 16:37:16 -07001015
Zackery Spytz43fdbd22019-05-29 13:57:07 -06001016A new :func:`os.memfd_create` function was added to wrap the
1017``memfd_create()`` syscall.
1018(Contributed by Zackery Spytz and Christian Heimes in :issue:`26836`.)
1019
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001020On Windows, much of the manual logic for handling reparse points (including
1021symlinks and directory junctions) has been delegated to the operating system.
1022Specifically, :func:`os.stat` will now traverse anything supported by the
1023operating system, while :func:`os.lstat` will only open reparse points that
1024identify as "name surrogates" while others are opened as for :func:`os.stat`.
1025In all cases, :attr:`stat_result.st_mode` will only have ``S_IFLNK`` set for
1026symbolic links and not other kinds of reparse points. To identify other kinds
1027of reparse point, check the new :attr:`stat_result.st_reparse_tag` attribute.
1028
1029On Windows, :func:`os.readlink` is now able to read directory junctions. Note
1030that :func:`~os.path.islink` will return ``False`` for directory junctions,
1031and so code that checks ``islink`` first will continue to treat junctions as
1032directories, while code that handles errors from :func:`os.readlink` may now
1033treat junctions as links.
1034
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001035(Contributed by Steve Dower in :issue:`37834`.)
1036
Pablo Galindobc098512019-02-07 07:04:02 +00001037
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001038os.path
1039-------
1040
1041:mod:`os.path` functions that return a boolean result like
1042:func:`~os.path.exists`, :func:`~os.path.lexists`, :func:`~os.path.isdir`,
1043:func:`~os.path.isfile`, :func:`~os.path.islink`, and :func:`~os.path.ismount`
1044now return ``False`` instead of raising :exc:`ValueError` or its subclasses
1045:exc:`UnicodeEncodeError` and :exc:`UnicodeDecodeError` for paths that contain
1046characters or bytes unrepresentable at the OS level.
1047(Contributed by Serhiy Storchaka in :issue:`33721`.)
1048
Steve Dower8ef864d2019-03-12 15:15:26 -07001049:func:`~os.path.expanduser` on Windows now prefers the :envvar:`USERPROFILE`
1050environment variable and does not use :envvar:`HOME`, which is not normally set
1051for regular user accounts.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001052(Contributed by Anthony Sottile in :issue:`36264`.)
Steve Dower8ef864d2019-03-12 15:15:26 -07001053
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001054:func:`~os.path.isdir` on Windows no longer returns true for a link to a
1055non-existent directory.
1056
Steve Dower75e06492019-08-21 13:43:06 -07001057:func:`~os.path.realpath` on Windows now resolves reparse points, including
1058symlinks and directory junctions.
1059
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001060(Contributed by Steve Dower in :issue:`37834`.)
1061
Serhiy Storchakab232df92018-10-30 13:22:42 +02001062
Serhiy Storchaka0185f342018-09-18 11:28:51 +03001063pathlib
1064-------
1065
1066:mod:`pathlib.Path` methods that return a boolean result like
1067:meth:`~pathlib.Path.exists()`, :meth:`~pathlib.Path.is_dir()`,
1068:meth:`~pathlib.Path.is_file()`, :meth:`~pathlib.Path.is_mount()`,
1069:meth:`~pathlib.Path.is_symlink()`, :meth:`~pathlib.Path.is_block_device()`,
1070:meth:`~pathlib.Path.is_char_device()`, :meth:`~pathlib.Path.is_fifo()`,
1071:meth:`~pathlib.Path.is_socket()` now return ``False`` instead of raising
1072:exc:`ValueError` or its subclass :exc:`UnicodeEncodeError` for paths that
1073contain characters unrepresentable at the OS level.
1074(Contributed by Serhiy Storchaka in :issue:`33721`.)
1075
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -04001076Added :meth:`pathlib.Path.link_to()` which creates a hard link pointing
1077to a path.
1078(Contributed by Joannah Nanjekye in :issue:`26978`)
1079
jab9e00d9e2018-12-28 13:03:40 -05001080
Pierre Glaserec6c1bd2019-07-01 15:51:57 +02001081pickle
1082------
1083
Pierre Glaserec6c1bd2019-07-01 15:51:57 +02001084:mod:`pickle` extensions subclassing the C-optimized :class:`~pickle.Pickler`
1085can now override the pickling logic of functions and classes by defining the
1086special :meth:`~pickle.Pickler.reducer_override` method.
Jero Badob1fa72a2019-10-18 15:48:48 +08001087(Contributed by Pierre Glaser and Olivier Grisel in :issue:`35900`.)
Pierre Glaserec6c1bd2019-07-01 15:51:57 +02001088
1089
Jon Janzenc981ad12019-05-15 22:14:38 +02001090plistlib
1091--------
1092
1093Added new :class:`plistlib.UID` and enabled support for reading and writing
1094NSKeyedArchiver-encoded binary plists.
1095(Contributed by Jon Janzen in :issue:`26707`.)
1096
1097
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001098pprint
1099------
1100
1101The :mod:`pprint` module added a *sort_dicts* parameter to several functions.
1102By default, those functions continue to sort dictionaries before rendering or
1103printing. However, if *sort_dicts* is set to *False*, the dictionaries retain
1104the order that keys were inserted. This can be useful for comparison to JSON
1105inputs during debugging.
1106
1107In addition, there is a convenience new function, :func:`pprint.pp` that is
1108like :func:`pprint.pprint` but with *sort_dicts* defaulting to *False*::
1109
1110 >>> from pprint import pprint, pp
1111 >>> d = dict(source='input.txt', operation='filter', destination='output.txt')
1112 >>> pp(d, width=40) # Original order
1113 {'source': 'input.txt',
1114 'operation': 'filter',
1115 'destination': 'output.txt'}
1116 >>> pprint(d, width=40) # Keys sorted alphabetically
1117 {'destination': 'output.txt',
1118 'operation': 'filter',
1119 'source': 'input.txt'}
1120
1121(Contributed by Rémi Lapeyre in :issue:`30670`.)
1122
1123
Joannah Nanjekye2e33ecd2019-05-28 13:29:04 -03001124py_compile
1125----------
1126
1127:func:`py_compile.compile` now supports silent mode.
1128(Contributed by Joannah Nanjekye in :issue:`22640`.)
1129
1130
Bo Baylesca804952019-05-29 03:06:12 -05001131shlex
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001132-----
Bo Baylesca804952019-05-29 03:06:12 -05001133
1134The new :func:`shlex.join` function acts as the inverse of :func:`shlex.split`.
1135(Contributed by Bo Bayles in :issue:`32102`.)
Giampaolo Rodolaeb7e29f2019-04-09 00:34:02 +02001136
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001137
jab9e00d9e2018-12-28 13:03:40 -05001138shutil
1139------
1140
1141:func:`shutil.copytree` now accepts a new ``dirs_exist_ok`` keyword argument.
1142(Contributed by Josh Bronson in :issue:`20849`.)
1143
CAM Gerlach89a89442019-04-06 23:47:49 -05001144:func:`shutil.make_archive` now defaults to the modern pax (POSIX.1-2001)
1145format for new archives to improve portability and standards conformance,
1146inherited from the corresponding change to the :mod:`tarfile` module.
1147(Contributed by C.A.M. Gerlach in :issue:`30661`.)
1148
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001149:func:`shutil.rmtree` on Windows now removes directory junctions without
1150recursively removing their contents first.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001151(Contributed by Steve Dower in :issue:`37834`.)
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001152
jab9e00d9e2018-12-28 13:03:40 -05001153
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001154socket
1155------
1156
1157Added :meth:`~socket.create_server()` and :meth:`~socket.has_dualstack_ipv6()`
1158convenience functions to automate the necessary tasks usually involved when
1159creating a server socket, including accepting both IPv4 and IPv6 connections
1160on the same socket. (Contributed by Giampaolo Rodolà in :issue:`17561`.)
1161
1162The :func:`socket.if_nameindex()`, :func:`socket.if_nametoindex()`, and
1163:func:`socket.if_indextoname()` functions have been implemented on Windows.
1164(Contributed by Zackery Spytz in :issue:`37007`.)
1165
1166
Christian Heimes9fb051f2018-09-23 08:32:31 +02001167ssl
1168---
1169
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001170Added :attr:`~ssl.SSLContext.post_handshake_auth` to enable and
1171:meth:`~ssl.SSLSocket.verify_client_post_handshake` to initiate TLS 1.3
Christian Heimes9fb051f2018-09-23 08:32:31 +02001172post-handshake authentication.
1173(Contributed by Christian Heimes in :issue:`34670`.)
1174
Raymond Hettinger47d99872019-02-21 15:06:29 -08001175
1176statistics
1177----------
1178
1179Added :func:`statistics.fmean` as a faster, floating point variant of
1180:func:`statistics.mean()`. (Contributed by Raymond Hettinger and
1181Steven D'Aprano in :issue:`35904`.)
1182
Raymond Hettinger6463ba32019-04-07 09:20:03 -07001183Added :func:`statistics.geometric_mean()`
1184(Contributed by Raymond Hettinger in :issue:`27181`.)
1185
Raymond Hettingerfc06a192019-03-12 00:43:27 -07001186Added :func:`statistics.multimode` that returns a list of the most
1187common values. (Contributed by Raymond Hettinger in :issue:`35892`.)
1188
Raymond Hettinger9013ccf2019-04-23 00:06:35 -07001189Added :func:`statistics.quantiles` that divides data or a distribution
1190in to equiprobable intervals (e.g. quartiles, deciles, or percentiles).
1191(Contributed by Raymond Hettinger in :issue:`36546`.)
1192
Raymond Hettinger11c79532019-02-23 14:44:07 -08001193Added :class:`statistics.NormalDist`, a tool for creating
1194and manipulating normal distributions of a random variable.
1195(Contributed by Raymond Hettinger in :issue:`36018`.)
1196
1197::
1198
1199 >>> temperature_feb = NormalDist.from_samples([4, 12, -3, 2, 7, 14])
Raymond Hettinger671d7822019-05-01 17:49:12 -07001200 >>> temperature_feb.mean
1201 6.0
1202 >>> temperature_feb.stdev
1203 6.356099432828281
Raymond Hettinger11c79532019-02-23 14:44:07 -08001204
1205 >>> temperature_feb.cdf(3) # Chance of being under 3 degrees
1206 0.3184678262814532
1207 >>> # Relative chance of being 7 degrees versus 10 degrees
1208 >>> temperature_feb.pdf(7) / temperature_feb.pdf(10)
1209 1.2039930378537762
1210
Raymond Hettinger671d7822019-05-01 17:49:12 -07001211 >>> el_niño = NormalDist(4, 2.5)
1212 >>> temperature_feb += el_niño # Add in a climate effect
Raymond Hettinger11c79532019-02-23 14:44:07 -08001213 >>> temperature_feb
1214 NormalDist(mu=10.0, sigma=6.830080526611674)
1215
1216 >>> temperature_feb * (9/5) + 32 # Convert to Fahrenheit
1217 NormalDist(mu=50.0, sigma=12.294144947901014)
1218 >>> temperature_feb.samples(3) # Generate random samples
1219 [7.672102882379219, 12.000027119750287, 4.647488369766392]
1220
Raymond Hettinger47d99872019-02-21 15:06:29 -08001221
Victor Stinneref9d9b62019-05-22 11:28:22 +02001222sys
1223---
1224
1225Add new :func:`sys.unraisablehook` function which can be overridden to control
1226how "unraisable exceptions" are handled. It is called when an exception has
1227occurred but there is no way for Python to handle it. For example, when a
1228destructor raises an exception or during garbage collection
1229(:func:`gc.collect`).
Victor Stinner01ae8972019-06-03 16:28:01 +02001230(Contributed by Victor Stinner in :issue:`36829`.)
Victor Stinneref9d9b62019-05-22 11:28:22 +02001231
1232
CAM Gerlache680c3d2019-03-21 09:44:51 -05001233tarfile
1234-------
1235
1236The :mod:`tarfile` module now defaults to the modern pax (POSIX.1-2001)
1237format for new archives, instead of the previous GNU-specific one.
1238This improves cross-platform portability with a consistent encoding (UTF-8)
1239in a standardized and extensible format, and offers several other benefits.
1240(Contributed by C.A.M. Gerlach in :issue:`36268`.)
1241
1242
Victor Stinnercd590a72019-05-28 00:39:52 +02001243threading
1244---------
1245
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001246Add a new :func:`threading.excepthook` function which handles uncaught
1247:meth:`threading.Thread.run` exception. It can be overridden to control how
1248uncaught :meth:`threading.Thread.run` exceptions are handled.
1249(Contributed by Victor Stinner in :issue:`1230540`.)
Jake Tesler84846b02019-07-30 14:41:46 -07001250
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001251Add a new :func:`threading.get_native_id` function and
1252a :data:`~threading.Thread.native_id`
1253attribute to the :class:`threading.Thread` class. These return the native
1254integral Thread ID of the current thread assigned by the kernel.
1255This feature is only available on certain platforms, see
1256:func:`get_native_id <threading.get_native_id>` for more information.
1257(Contributed by Jake Tesler in :issue:`36084`.)
Victor Stinnercd590a72019-05-28 00:39:52 +02001258
1259
Tal Einatdfba1f62018-10-24 10:20:05 +03001260tokenize
1261--------
1262
1263The :mod:`tokenize` module now implicitly emits a ``NEWLINE`` token when
1264provided with input that does not have a trailing new line. This behavior
1265now matches what the C tokenizer does internally.
1266(Contributed by Ammar Askar in :issue:`33899`.)
1267
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001268
Juliette Monselaf5658a2018-10-08 18:29:24 +02001269tkinter
1270-------
1271
1272Added methods :meth:`~tkinter.Spinbox.selection_from`,
1273:meth:`~tkinter.Spinbox.selection_present`,
1274:meth:`~tkinter.Spinbox.selection_range` and
1275:meth:`~tkinter.Spinbox.selection_to`
1276in the :class:`tkinter.Spinbox` class.
1277(Contributed by Juliette Monsel in :issue:`34829`.)
1278
Juliette Monselbf034712018-10-12 18:44:10 +02001279Added method :meth:`~tkinter.Canvas.moveto`
1280in the :class:`tkinter.Canvas` class.
1281(Contributed by Juliette Monsel in :issue:`23831`.)
1282
Zackery Spytz50866e92019-04-05 04:17:13 -06001283The :class:`tkinter.PhotoImage` class now has
1284:meth:`~tkinter.PhotoImage.transparency_get` and
1285:meth:`~tkinter.PhotoImage.transparency_set` methods. (Contributed by
1286Zackery Spytz in :issue:`25451`.)
1287
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001288
Joannah Nanjekye572168a2019-01-10 19:56:38 +03001289time
1290----
1291
1292Added new clock :data:`~time.CLOCK_UPTIME_RAW` for macOS 10.12.
1293(Contributed by Joannah Nanjekye in :issue:`35702`.)
1294
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001295
1296typing
1297------
1298
1299The :mod:`typing` module incorporates several new features:
1300
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001301* A dictionary type with per-key types. See :pep:`589` and
1302 :class:`typing.TypedDict`.
Raymond Hettingera3291532019-10-13 23:32:03 -07001303 TypedDict uses only string keys. By default, every key is required
1304 to be present. Specify "total=False" to allow keys to be optional::
1305
1306 class Location(TypedDict, total=False):
1307 lat_long: tuple
1308 grid_square: str
1309 xy_coordinate: tuple
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001310
1311* Literal types. See :pep:`586` and :class:`typing.Literal`.
Raymond Hettingera3291532019-10-13 23:32:03 -07001312 Literal types indicate that a parameter or return value
1313 is constrained to one or more specific literal values::
1314
1315 def get_status(port: int) -> Literal['connected', 'disconnected']:
1316 ...
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001317
1318* "Final" variables, functions, methods and classes. See :pep:`591`,
1319 :class:`typing.Final` and :func:`typing.final`.
Raymond Hettingera3291532019-10-13 23:32:03 -07001320 The final qualifier instructs a static type checker to restrict
1321 subclassing, overriding, or reassignment::
1322
1323 pi: Final[float] = 3.1415926536
1324
1325* Protocol definitions. See :pep:`544`, :class:`typing.Protocol` and
1326 :func:`typing.runtime_checkable`. Simple ABCs like
1327 :class:`typing.SupportsInt` are now ``Protocol`` subclasses.
Guido van Rossum9b33ce42019-06-11 13:42:35 -07001328
1329* New protocol class :class:`typing.SupportsIndex`.
1330
1331* New functions :func:`typing.get_origin` and :func:`typing.get_args`.
1332
1333
Max Bélanger2810dd72018-11-04 15:58:24 -08001334unicodedata
1335-----------
1336
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001337The :mod:`unicodedata` module has been upgraded to use the `Unicode 12.1.0
1338<http://blog.unicode.org/2019/05/unicode-12-1-en.html>`_ release.
Raymond Hettinger482b6b52019-05-01 17:48:13 -07001339
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001340New function :func:`~unicodedata.is_normalized` can be used to verify a string
1341is in a specific normal form, often much faster than by actually normalizing
1342the string. (Contributed by Max Belanger, David Euresti, and Greg Price in
1343:issue:`32285` and :issue:`37966`).
Max Bélanger2810dd72018-11-04 15:58:24 -08001344
Raymond Hettinger482b6b52019-05-01 17:48:13 -07001345
Lisa Roach0f221d02018-11-08 18:34:33 -08001346unittest
1347--------
1348
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001349Added :class:`~unittest.mock.AsyncMock` to support an asynchronous version of
1350:class:`~unittest.mock.Mock`. Appropriate new assert functions for testing
1351have been added as well.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001352(Contributed by Lisa Roach in :issue:`26467`).
Lisa Roach77b3b772019-05-20 09:19:53 -07001353
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001354Added :func:`~unittest.addModuleCleanup()` and
1355:meth:`~unittest.TestCase.addClassCleanup()` to unittest to support
1356cleanups for :func:`~unittest.setUpModule()` and
1357:meth:`~unittest.TestCase.setUpClass()`.
1358(Contributed by Lisa Roach in :issue:`24412`.)
Lisa Roach0f221d02018-11-08 18:34:33 -08001359
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001360Several mock assert functions now also print a list of actual calls upon
1361failure. (Contributed by Petter Strandmark in :issue:`35047`.)
Petter Strandmark001d63c2019-06-04 21:34:49 +02001362
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001363:mod:`unittest` module gained support for coroutines to be used as test cases
1364with :class:`unittest.IsolatedAsyncioTestCase`.
1365(Contributed by Andrew Svetlov in :issue:`32972`.)
Xtreak6a9fd662019-09-11 12:02:14 +01001366
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001367Example::
Xtreak6a9fd662019-09-11 12:02:14 +01001368
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001369 import unittest
Xtreak6a9fd662019-09-11 12:02:14 +01001370
1371
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001372 class TestRequest(unittest.IsolatedAsyncioTestCase):
Xtreak6a9fd662019-09-11 12:02:14 +01001373
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001374 async def asyncSetUp(self):
1375 self.connection = await AsyncConnection()
Xtreak6a9fd662019-09-11 12:02:14 +01001376
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001377 async def test_get(self):
1378 response = await self.connection.get("https://example.com")
1379 self.assertEqual(response.status_code, 200)
Xtreak6a9fd662019-09-11 12:02:14 +01001380
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001381 async def asyncTearDown(self):
1382 await self.connection.close()
Xtreak6a9fd662019-09-11 12:02:14 +01001383
1384
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001385 if __name__ == "__main__":
1386 unittest.main()
Xtreak6a9fd662019-09-11 12:02:14 +01001387
1388
Brett Cannond64ee1a2018-09-21 15:27:26 -07001389venv
1390----
1391
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001392:mod:`venv` now includes an ``Activate.ps1`` script on all platforms for
1393activating virtual environments under PowerShell Core 6.1.
1394(Contributed by Brett Cannon in :issue:`32718`.)
1395
Brett Cannond64ee1a2018-09-21 15:27:26 -07001396
Mark Dickinson7abb6c02019-04-26 15:56:15 +09001397weakref
1398-------
1399
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001400The proxy objects returned by :func:`weakref.proxy` now support the matrix
1401multiplication operators ``@`` and ``@=`` in addition to the other
1402numeric operators. (Contributed by Mark Dickinson in :issue:`36669`.)
1403
Mark Dickinson7abb6c02019-04-26 15:56:15 +09001404
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001405xml
1406---
1407
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001408As mitigation against DTD and external entity retrieval, the
1409:mod:`xml.dom.minidom` and :mod:`xml.sax` modules no longer process
1410external entities by default.
1411(Contributed by Christian Heimes in :issue:`17239`.)
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001412
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001413The ``.find*()`` methods in the :mod:`xml.etree.ElementTree` module
1414support wildcard searches like ``{*}tag`` which ignores the namespace
1415and ``{namespace}*`` which returns all tags in the given namespace.
1416(Contributed by Stefan Behnel in :issue:`28238`.)
Stefan Behnel47541682019-05-03 20:58:16 +02001417
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001418The :mod:`xml.etree.ElementTree` module provides a new function
1419:func:`–xml.etree.ElementTree.canonicalize()` that implements C14N 2.0.
1420(Contributed by Stefan Behnel in :issue:`13611`.)
Stefan Behnele1d5dd62019-05-01 22:34:13 +02001421
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001422The target object of :class:`xml.etree.ElementTree.XMLParser` can
1423receive namespace declaration events through the new callback methods
1424``start_ns()`` and ``end_ns()``. Additionally, the
1425:class:`xml.etree.ElementTree.TreeBuilder` target can be configured
1426to process events about comments and processing instructions to include
1427them in the generated tree.
1428(Contributed by Stefan Behnel in :issue:`36676` and :issue:`36673`.)
1429
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001430
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001431xmlrpc
1432------
1433
1434:class:`xmlrpc.client.ServerProxy` now supports an optional *headers* keyword
1435argument for a sequence of HTTP headers to be sent with each request. Among
1436other things, this makes it possible to upgrade from default basic
1437authentication to faster session authentication.
1438(Contributed by Cédric Krier in :issue:`35153`.)
1439
1440
Ned Deily07a18922018-01-31 18:12:38 -05001441Optimizations
1442=============
1443
Victor Stinner9daecf32019-01-16 00:02:35 +01001444* The :mod:`subprocess` module can now use the :func:`os.posix_spawn` function
1445 in some cases for better performance. Currently, it is only used on macOS
1446 and Linux (using glibc 2.24 or newer) if all these conditions are met:
1447
1448 * *close_fds* is false;
Victor Stinnerf6243ac2019-01-23 19:00:39 +01001449 * *preexec_fn*, *pass_fds*, *cwd* and *start_new_session* parameters
1450 are not set;
Victor Stinner8c349562019-01-16 23:38:06 +01001451 * the *executable* path contains a directory.
Victor Stinner9daecf32019-01-16 00:02:35 +01001452
Victor Stinner01ae8972019-06-03 16:28:01 +02001453 (Contributed by Joannah Nanjekye and Victor Stinner in :issue:`35537`.)
1454
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02001455* :func:`shutil.copyfile`, :func:`shutil.copy`, :func:`shutil.copy2`,
1456 :func:`shutil.copytree` and :func:`shutil.move` use platform-specific
Giampaolo Rodola413d9552019-05-30 14:05:41 +08001457 "fast-copy" syscalls on Linux and macOS in order to copy the file
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07001458 more efficiently.
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02001459 "fast-copy" means that the copying operation occurs within the kernel,
1460 avoiding the use of userspace buffers in Python as in
1461 "``outfd.write(infd.read())``".
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07001462 On Windows :func:`shutil.copyfile` uses a bigger default buffer size (1 MiB
1463 instead of 16 KiB) and a :func:`memoryview`-based variant of
1464 :func:`shutil.copyfileobj` is used.
1465 The speedup for copying a 512 MiB file within the same partition is about
1466 +26% on Linux, +50% on macOS and +40% on Windows. Also, much less CPU cycles
1467 are consumed.
1468 See :ref:`shutil-platform-dependent-efficient-copy-operations` section.
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001469 (Contributed by Giampaolo Rodolà in :issue:`33671`.)
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02001470
Giampaolo Rodola19c46a42018-11-12 06:18:15 -08001471* :func:`shutil.copytree` uses :func:`os.scandir` function and all copy
1472 functions depending from it use cached :func:`os.stat` values. The speedup
1473 for copying a directory with 8000 files is around +9% on Linux, +20% on
1474 Windows and +30% on a Windows SMB share. Also the number of :func:`os.stat`
1475 syscalls is reduced by 38% making :func:`shutil.copytree` especially faster
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001476 on network filesystems. (Contributed by Giampaolo Rodolà in :issue:`33695`.)
Giampaolo Rodola19c46a42018-11-12 06:18:15 -08001477
Łukasz Langac51d8c92018-04-03 23:06:53 -07001478* The default protocol in the :mod:`pickle` module is now Protocol 4,
1479 first introduced in Python 3.4. It offers better performance and smaller
1480 size compared to Protocol 3 available since Python 3.0.
Ned Deily07a18922018-01-31 18:12:38 -05001481
INADA Naokid5c875b2018-07-11 17:42:49 +09001482* Removed one ``Py_ssize_t`` member from ``PyGC_Head``. All GC tracked
1483 objects (e.g. tuple, list, dict) size is reduced 4 or 8 bytes.
Jero Badob1fa72a2019-10-18 15:48:48 +08001484 (Contributed by Inada Naoki in :issue:`33597`.)
INADA Naokid5c875b2018-07-11 17:42:49 +09001485
Tal Einat54752532018-09-10 16:11:04 +03001486* :class:`uuid.UUID` now uses ``__slots__`` to reduce its memory footprint.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001487 (Contributed by Wouter Bolsterlee and Tal Einat in :issue:`30977`)
Tal Einat54752532018-09-10 16:11:04 +03001488
Raymond Hettinger63fa1cf2019-02-16 12:02:22 -08001489* Improved performance of :func:`operator.itemgetter` by 33%. Optimized
1490 argument handling and added a fast path for the common case of a single
1491 non-negative integer index into a tuple (which is the typical use case in
1492 the standard library). (Contributed by Raymond Hettinger in
1493 :issue:`35664`.)
1494
1495* Sped-up field lookups in :func:`collections.namedtuple`. They are now more
1496 than two times faster, making them the fastest form of instance variable
1497 lookup in Python. (Contributed by Raymond Hettinger, Pablo Galindo, and
Joe Jevnikf36f8922019-02-21 16:00:40 -05001498 Joe Jevnik, Serhiy Storchaka in :issue:`32492`.)
Raymond Hettinger63fa1cf2019-02-16 12:02:22 -08001499
Pablo Galindoc61e2292018-10-28 22:03:18 +00001500* The :class:`list` constructor does not overallocate the internal item buffer
1501 if the input iterable has a known length (the input implements ``__len__``).
Raymond Hettingere1823182019-02-16 12:47:48 -08001502 This makes the created list 12% smaller on average. (Contributed by
1503 Raymond Hettinger and Pablo Galindo in :issue:`33234`.)
Pablo Galindoc61e2292018-10-28 22:03:18 +00001504
Stefan Behneld8b9e1f2019-02-20 18:29:24 +01001505* Doubled the speed of class variable writes. When a non-dunder attribute
1506 was updated, there was an unnecessary call to update slots.
1507 (Contributed by Stefan Behnel, Pablo Galindo Salgado, Raymond Hettinger,
1508 Neil Schemenauer, and Serhiy Storchaka in :issue:`36012`.)
1509
Serhiy Storchaka31913912019-03-14 10:32:22 +02001510* Reduced an overhead of converting arguments passed to many builtin functions
1511 and methods. This sped up calling some simple builtin functions and
1512 methods up to 20--50%. (Contributed by Serhiy Storchaka in :issue:`23867`,
1513 :issue:`35582` and :issue:`36127`.)
1514
Inada Naoki91234a12019-06-03 21:30:58 +09001515* ``LOAD_GLOBAL`` instruction now uses new "per opcode cache" mechanism.
1516 It is about 40% faster now. (Contributed by Yury Selivanov and Inada Naoki in
1517 :issue:`26219`.)
1518
Serhiy Storchakaceeef102018-06-15 11:09:43 +03001519
Ned Deily07a18922018-01-31 18:12:38 -05001520Build and C API Changes
1521=======================
1522
Victor Stinner7efc5262019-06-15 03:24:41 +02001523* Default :data:`sys.abiflags` became an empty string: the ``m`` flag for
1524 pymalloc became useless (builds with and without pymalloc are ABI compatible)
1525 and so has been removed. (Contributed by Victor Stinner in :issue:`36707`.)
1526
1527 Example of changes:
1528
1529 * Only ``python3.8`` program is installed, ``python3.8m`` program is gone.
1530 * Only ``python3.8-config`` script is installed, ``python3.8m-config`` script
1531 is gone.
1532 * The ``m`` flag has been removed from the suffix of dynamic library
1533 filenames: extension modules in the standard library as well as those
1534 produced and installed by third-party packages, like those downloaded from
1535 PyPI. On Linux, for example, the Python 3.7 suffix
1536 ``.cpython-37m-x86_64-linux-gnu.so`` became
1537 ``.cpython-38-x86_64-linux-gnu.so`` in Python 3.8.
1538
Victor Stinnerbd5798f2019-06-14 19:43:43 +02001539* The header files have been reorganized to better separate the different kinds
1540 of APIs:
1541
1542 * ``Include/*.h`` should be the portable public stable C API.
1543 * ``Include/cpython/*.h`` should be the unstable C API specific to CPython;
Victor Stinneraf41c562019-06-20 01:44:58 +02001544 public API, with some private API prefixed by ``_Py`` or ``_PY``.
Victor Stinnerbd5798f2019-06-14 19:43:43 +02001545 * ``Include/internal/*.h`` is the private internal C API very specific to
1546 CPython. This API comes with no backward compatibility warranty and should
1547 not be used outside CPython. It is only exposed for very specific needs
1548 like debuggers and profiles which has to access to CPython internals
1549 without calling functions. This API is now installed by ``make install``.
1550
1551 (Contributed by Victor Stinner in :issue:`35134` and :issue:`35081`,
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001552 work initiated by Eric Snow in Python 3.7.)
Victor Stinnerbd5798f2019-06-14 19:43:43 +02001553
1554* Some macros have been converted to static inline functions: parameter types
1555 and return type are well defined, they don't have issues specific to macros,
1556 variables have a local scopes. Examples:
1557
1558 * :c:func:`Py_INCREF`, :c:func:`Py_DECREF`
1559 * :c:func:`Py_XINCREF`, :c:func:`Py_XDECREF`
1560 * :c:func:`PyObject_INIT`, :c:func:`PyObject_INIT_VAR`
1561 * Private functions: :c:func:`_PyObject_GC_TRACK`,
1562 :c:func:`_PyObject_GC_UNTRACK`, :c:func:`_Py_Dealloc`
1563
1564 (Contributed by Victor Stinner in :issue:`35059`.)
1565
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001566* The :c:func:`PyByteArray_Init` and :c:func:`PyByteArray_Fini` functions have
1567 been removed. They did nothing since Python 2.7.4 and Python 3.2.0, were
1568 excluded from the limited API (stable ABI), and were not documented.
Victor Stinnerc68e3fb2019-06-20 22:41:25 +02001569 (Contributed by Victor Stinner in :issue:`35713`.)
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001570
Serhiy Storchakaceeef102018-06-15 11:09:43 +03001571* The result of :c:func:`PyExceptionClass_Name` is now of type
1572 ``const char *`` rather of ``char *``.
1573 (Contributed by Serhiy Storchaka in :issue:`33818`.)
Ned Deily07a18922018-01-31 18:12:38 -05001574
Antoine Pitrou961d54c2018-07-16 19:03:03 +02001575* The duality of ``Modules/Setup.dist`` and ``Modules/Setup`` has been
1576 removed. Previously, when updating the CPython source tree, one had
1577 to manually copy ``Modules/Setup.dist`` (inside the source tree) to
1578 ``Modules/Setup`` (inside the build tree) in order to reflect any changes
1579 upstream. This was of a small benefit to packagers at the expense of
1580 a frequent annoyance to developers following CPython development, as
1581 forgetting to copy the file could produce build failures.
1582
1583 Now the build system always reads from ``Modules/Setup`` inside the source
1584 tree. People who want to customize that file are encouraged to maintain
1585 their changes in a git fork of CPython or as patch files, as they would do
1586 for any other change to the source tree.
1587
1588 (Contributed by Antoine Pitrou in :issue:`32430`.)
1589
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001590* Functions that convert Python number to C integer like
1591 :c:func:`PyLong_AsLong` and argument parsing functions like
1592 :c:func:`PyArg_ParseTuple` with integer converting format units like ``'i'``
1593 will now use the :meth:`~object.__index__` special method instead of
1594 :meth:`~object.__int__`, if available. The deprecation warning will be
1595 emitted for objects with the ``__int__()`` method but without the
1596 ``__index__()`` method (like :class:`~decimal.Decimal` and
1597 :class:`~fractions.Fraction`). :c:func:`PyNumber_Check` will now return
1598 ``1`` for objects implementing ``__index__()``.
Serhiy Storchakabdbad712019-06-02 00:05:48 +03001599 :c:func:`PyNumber_Long`, :c:func:`PyNumber_Float` and
1600 :c:func:`PyFloat_AsDouble` also now use the ``__index__()`` method if
1601 available.
1602 (Contributed by Serhiy Storchaka in :issue:`36048` and :issue:`20092`.)
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001603
Eddie Elizondo364f0b02019-03-27 07:52:18 -04001604* Heap-allocated type objects will now increase their reference count
1605 in :c:func:`PyObject_Init` (and its parallel macro ``PyObject_INIT``)
1606 instead of in :c:func:`PyType_GenericAlloc`. Types that modify instance
1607 allocation or deallocation may need to be adjusted.
1608 (Contributed by Eddie Elizondo in :issue:`35810`.)
1609
Pablo Galindo4a2edc32019-07-01 11:35:05 +01001610* The new function :c:func:`PyCode_NewWithPosOnlyArgs` allows to create
1611 code objects like :c:func:`PyCode_New`, but with an extra *posonlyargcount*
1612 parameter for indicating the number of positional-only arguments.
1613 (Contributed by Pablo Galindo in :issue:`37221`.)
1614
Victor Stinner1ce152a2019-09-24 17:44:15 +02001615* :c:func:`Py_SetPath` now sets :data:`sys.executable` to the program full
1616 path (:c:func:`Py_GetProgramFullPath`) rather than to the program name
1617 (:c:func:`Py_GetProgramName`).
1618 (Contributed by Victor Stinner in :issue:`38234`.)
1619
Ned Deily07a18922018-01-31 18:12:38 -05001620
1621Deprecated
1622==========
1623
Victor Stinner1da44622019-07-05 10:44:12 +02001624* The distutils ``bdist_wininst`` command is now deprecated, use
1625 ``bdist_wheel`` (wheel packages) instead.
1626 (Contributed by Victor Stinner in :issue:`37481`.)
1627
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001628* Deprecated methods ``getchildren()`` and ``getiterator()`` in
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001629 the :mod:`~xml.etree.ElementTree` module now emit a
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001630 :exc:`DeprecationWarning` instead of :exc:`PendingDeprecationWarning`.
1631 They will be removed in Python 3.9.
1632 (Contributed by Serhiy Storchaka in :issue:`29209`.)
Ned Deily07a18922018-01-31 18:12:38 -05001633
Elvis Pranskevichus22d25082018-07-30 11:42:43 +01001634* Passing an object that is not an instance of
1635 :class:`concurrent.futures.ThreadPoolExecutor` to
Kyle Stanley3bbb6db2019-10-24 00:15:25 -04001636 :meth:`loop.set_default_executor() <asyncio.loop.set_default_executor>` is
Elvis Pranskevichus22d25082018-07-30 11:42:43 +01001637 deprecated and will be prohibited in Python 3.9.
1638 (Contributed by Elvis Pranskevichus in :issue:`34075`.)
1639
Berker Peksagef8861c2018-08-21 17:58:49 +03001640* The :meth:`__getitem__` methods of :class:`xml.dom.pulldom.DOMEventStream`,
1641 :class:`wsgiref.util.FileWrapper` and :class:`fileinput.FileInput` have been
1642 deprecated.
1643
1644 Implementations of these methods have been ignoring their *index* parameter,
1645 and returning the next item instead.
Berker Peksagef8861c2018-08-21 17:58:49 +03001646 (Contributed by Berker Peksag in :issue:`9372`.)
1647
Raymond Hettingerf7b57df2019-03-18 09:53:56 -07001648* The :class:`typing.NamedTuple` class has deprecated the ``_field_types``
1649 attribute in favor of the ``__annotations__`` attribute which has the same
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001650 information. (Contributed by Raymond Hettinger in :issue:`36320`.)
Raymond Hettingerf7b57df2019-03-18 09:53:56 -07001651
Serhiy Storchaka3f228112018-09-27 17:42:37 +03001652* :mod:`ast` classes ``Num``, ``Str``, ``Bytes``, ``NameConstant`` and
1653 ``Ellipsis`` are considered deprecated and will be removed in future Python
1654 versions. :class:`~ast.Constant` should be used instead.
1655 (Contributed by Serhiy Storchaka in :issue:`32892`.)
1656
Serhiy Storchakac3ea41e2019-08-26 10:13:19 +03001657* :class:`ast.NodeVisitor` methods ``visit_Num()``, ``visit_Str()``,
1658 ``visit_Bytes()``, ``visit_NameConstant()`` and ``visit_Ellipsis()`` are
1659 deprecated now and will not be called in future Python versions.
1660 Add the :meth:`~ast.NodeVisitor.visit_Constant` method to handle all
1661 constant nodes.
1662 (Contributed by Serhiy Storchaka in :issue:`36917`.)
1663
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001664* The :func:`asyncio.coroutine` :term:`decorator` is deprecated and will be
1665 removed in version 3.10. Instead of ``@asyncio.coroutine``, use
1666 :keyword:`async def` instead.
1667 (Contributed by Andrew Svetlov in :issue:`36921`.)
1668
Kyle Stanley3bbb6db2019-10-24 00:15:25 -04001669* In :mod:`asyncio`, the explicit passing of a *loop* argument has been
1670 deprecated and will be removed in version 3.10 for the following:
1671 :func:`asyncio.sleep`, :func:`asyncio.gather`, :func:`asyncio.shield`,
1672 :func:`asyncio.wait_for`, :func:`asyncio.wait`, :func:`asyncio.as_completed`,
1673 :class:`asyncio.Task`, :class:`asyncio.Lock`, :class:`asyncio.Event`,
1674 :class:`asyncio.Condition`, :class:`asyncio.Semaphore`,
1675 :class:`asyncio.BoundedSemaphore`, :class:`asyncio.Queue`,
1676 :func:`asyncio.create_subprocess_exec`, and
1677 :func:`asyncio.create_subprocess_shell`.
1678
1679* The explicit passing of coroutine objects to :func:`asyncio.wait` has been
Kyle Stanley457306b2019-10-28 21:53:22 -04001680 deprecated and will be removed in version 3.11.
1681 (Contributed by Yury Selivanov in :issue:`34790`.)
Kyle Stanley3bbb6db2019-10-24 00:15:25 -04001682
Serhiy Storchakafec35c92018-10-27 08:00:41 +03001683* The following functions and methods are deprecated in the :mod:`gettext`
1684 module: :func:`~gettext.lgettext`, :func:`~gettext.ldgettext`,
1685 :func:`~gettext.lngettext` and :func:`~gettext.ldngettext`.
1686 They return encoded bytes, and it's possible that you will get unexpected
1687 Unicode-related exceptions if there are encoding problems with the
1688 translated strings. It's much better to use alternatives which return
1689 Unicode strings in Python 3. These functions have been broken for a long time.
1690
1691 Function :func:`~gettext.bind_textdomain_codeset`, methods
1692 :meth:`~gettext.NullTranslations.output_charset` and
1693 :meth:`~gettext.NullTranslations.set_output_charset`, and the *codeset*
1694 parameter of functions :func:`~gettext.translation` and
1695 :func:`~gettext.install` are also deprecated, since they are only used for
1696 for the ``l*gettext()`` functions.
Serhiy Storchakafec35c92018-10-27 08:00:41 +03001697 (Contributed by Serhiy Storchaka in :issue:`33710`.)
1698
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001699* The :meth:`~threading.Thread.isAlive()` method of :class:`threading.Thread`
1700 has been deprecated.
Dong-hee Na89669ff2019-01-17 21:14:45 +09001701 (Contributed by Dong-hee Na in :issue:`35283`.)
Ned Deily07a18922018-01-31 18:12:38 -05001702
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001703* Many builtin and extension functions that take integer arguments will
1704 now emit a deprecation warning for :class:`~decimal.Decimal`\ s,
1705 :class:`~fractions.Fraction`\ s and any other objects that can be converted
1706 to integers only with a loss (e.g. that have the :meth:`~object.__int__`
1707 method but do not have the :meth:`~object.__index__` method). In future
1708 version they will be errors.
1709 (Contributed by Serhiy Storchaka in :issue:`36048`.)
1710
Serhiy Storchaka42a139e2019-04-01 09:16:35 +03001711* Deprecated passing the following arguments as keyword arguments:
1712
1713 - *func* in :func:`functools.partialmethod`, :func:`weakref.finalize`,
1714 :meth:`profile.Profile.runcall`, :meth:`cProfile.Profile.runcall`,
1715 :meth:`bdb.Bdb.runcall`, :meth:`trace.Trace.runfunc` and
1716 :func:`curses.wrapper`.
Serhiy Storchaka2085bd02019-06-01 11:00:15 +03001717 - *function* in :meth:`unittest.TestCase.addCleanup`.
Serhiy Storchaka42a139e2019-04-01 09:16:35 +03001718 - *fn* in the :meth:`~concurrent.futures.Executor.submit` method of
1719 :class:`concurrent.futures.ThreadPoolExecutor` and
1720 :class:`concurrent.futures.ProcessPoolExecutor`.
1721 - *callback* in :meth:`contextlib.ExitStack.callback`,
1722 :meth:`contextlib.AsyncExitStack.callback` and
1723 :meth:`contextlib.AsyncExitStack.push_async_callback`.
1724 - *c* and *typeid* in the :meth:`~multiprocessing.managers.Server.create`
1725 method of :class:`multiprocessing.managers.Server` and
1726 :class:`multiprocessing.managers.SharedMemoryServer`.
1727 - *obj* in :func:`weakref.finalize`.
1728
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001729 In future releases of Python, they will be :ref:`positional-only
Serhiy Storchaka42a139e2019-04-01 09:16:35 +03001730 <positional-only_parameter>`.
1731 (Contributed by Serhiy Storchaka in :issue:`36492`.)
1732
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001733
Victor Stinner73104fa2018-11-29 09:58:20 +01001734API and Feature Removals
1735========================
1736
1737The following features and APIs have been removed from Python 3.8:
1738
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001739* Starting with Python 3.3, importing ABCs from :mod:`collections` was
1740 deprecated, and importing should be done from :mod:`collections.abc`. Being
1741 able to import from collections was marked for removal in 3.8, but has been
1742 delayed to 3.9. (See :issue:`36952`.)
1743
Victor Stinnerd7538dd2018-12-14 13:37:26 +01001744* The :mod:`macpath` module, deprecated in Python 3.7, has been removed.
1745 (Contributed by Victor Stinner in :issue:`35471`.)
1746
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001747* The function :func:`platform.popen` has been removed, after having been
1748 deprecated since Python 3.3: use :func:`os.popen` instead.
Victor Stinner01ae8972019-06-03 16:28:01 +02001749 (Contributed by Victor Stinner in :issue:`35345`.)
Ned Deily07a18922018-01-31 18:12:38 -05001750
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001751* The function :func:`time.clock` has been removed, after having been
1752 deprecated since Python 3.3: use :func:`time.perf_counter` or
1753 :func:`time.process_time` instead, depending
1754 on your requirements, to have well-defined behavior.
Victor Stinner01ae8972019-06-03 16:28:01 +02001755 (Contributed by Matthias Bussonnier in :issue:`36895`.)
Matthias Bussonnierb6a09ae2019-05-13 12:23:07 -07001756
Brett Cannona8c34242018-04-20 14:15:40 -07001757* The ``pyvenv`` script has been removed in favor of ``python3.8 -m venv``
1758 to help eliminate confusion as to what Python interpreter the ``pyvenv``
1759 script is tied to. (Contributed by Brett Cannon in :issue:`25427`.)
Ned Deily07a18922018-01-31 18:12:38 -05001760
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001761* ``parse_qs``, ``parse_qsl``, and ``escape`` are removed from the :mod:`cgi`
1762 module. They are deprecated in Python 3.2 or older. They should be imported
Simon Willison1abf5432019-09-11 09:25:26 -05001763 from the ``urllib.parse`` and ``html`` modules instead.
INADA Naoki698865d2018-06-19 17:28:50 +09001764
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001765* ``filemode`` function is removed from the :mod:`tarfile` module.
INADA Naoki461a1c42018-06-28 17:10:36 +09001766 It is not documented and deprecated since Python 3.3.
INADA Naoki698865d2018-06-19 17:28:50 +09001767
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001768* The :class:`~xml.etree.ElementTree.XMLParser` constructor no longer accepts
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001769 the *html* argument. It never had an effect and was deprecated in Python 3.4.
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001770 All other parameters are now :ref:`keyword-only <keyword-only_parameter>`.
1771 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1772
1773* Removed the ``doctype()`` method of :class:`~xml.etree.ElementTree.XMLParser`.
1774 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1775
Inada Naoki6a16b182019-03-18 15:44:11 +09001776* "unicode_internal" codec is removed.
1777 (Contributed by Inada Naoki in :issue:`36297`.)
1778
Aviv Palivodae6576242019-05-09 21:05:45 +03001779* The ``Cache`` and ``Statement`` objects of the :mod:`sqlite3` module are not
1780 exposed to the user.
1781 (Contributed by Aviv Palivoda in :issue:`30262`.)
1782
Matthias Bussonnier1a3faf92019-05-20 13:44:11 -07001783* The ``bufsize`` keyword argument of :func:`fileinput.input` and
1784 :func:`fileinput.FileInput` which was ignored and deprecated since Python 3.6
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001785 has been removed. :issue:`36952` (Contributed by Matthias Bussonnier.)
Matthias Bussonnier1a3faf92019-05-20 13:44:11 -07001786
Matthias Bussonnier382034b2019-05-28 10:30:35 -07001787* The functions :func:`sys.set_coroutine_wrapper` and
1788 :func:`sys.get_coroutine_wrapper` deprecated in Python 3.7 have been removed;
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001789 :issue:`36933` (Contributed by Matthias Bussonnier.)
Matthias Bussonnier3880f262019-05-28 00:10:59 -07001790
Ned Deily07a18922018-01-31 18:12:38 -05001791
1792Porting to Python 3.8
1793=====================
1794
1795This section lists previously described changes and other bugfixes
1796that may require changes to your code.
1797
1798
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001799Changes in Python behavior
1800--------------------------
1801
1802* Yield expressions (both ``yield`` and ``yield from`` clauses) are now disallowed
1803 in comprehensions and generator expressions (aside from the iterable expression
Serhiy Storchaka2b57c432018-12-19 08:09:46 +02001804 in the leftmost :keyword:`!for` clause).
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001805 (Contributed by Serhiy Storchaka in :issue:`10544`.)
1806
Serhiy Storchaka3bcbedc2019-01-18 07:47:48 +02001807* The compiler now produces a :exc:`SyntaxWarning` when identity checks
1808 (``is`` and ``is not``) are used with certain types of literals
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001809 (e.g. strings, numbers). These can often work by accident in CPython,
Serhiy Storchaka3bcbedc2019-01-18 07:47:48 +02001810 but are not guaranteed by the language spec. The warning advises users
1811 to use equality tests (``==`` and ``!=``) instead.
1812 (Contributed by Serhiy Storchaka in :issue:`34850`.)
1813
Serhiy Storchaka7a0630c2019-04-08 14:34:04 +03001814* The CPython interpreter can swallow exceptions in some circumstances.
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001815 In Python 3.8 this happens in fewer cases. In particular, exceptions
Serhiy Storchaka7a0630c2019-04-08 14:34:04 +03001816 raised when getting the attribute from the type dictionary are no longer
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001817 ignored. (Contributed by Serhiy Storchaka in :issue:`35459`.)
Serhiy Storchaka7a0630c2019-04-08 14:34:04 +03001818
Serhiy Storchaka96aeaec2019-05-06 22:29:40 +03001819* Removed ``__str__`` implementations from builtin types :class:`bool`,
1820 :class:`int`, :class:`float`, :class:`complex` and few classes from
1821 the standard library. They now inherit ``__str__()`` from :class:`object`.
1822 As result, defining the ``__repr__()`` method in the subclass of these
barioddd6117c2019-09-27 20:01:33 +02001823 classes will affect their string representation.
Serhiy Storchaka96aeaec2019-05-06 22:29:40 +03001824 (Contributed by Serhiy Storchaka in :issue:`36793`.)
1825
Michael Felt9d949f72019-04-12 16:15:32 +02001826* On AIX, :attr:`sys.platform` doesn't contain the major version anymore.
1827 It is always ``'aix'``, instead of ``'aix3'`` .. ``'aix7'``. Since
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001828 older Python versions include the version number, so it is recommended to
1829 always use ``sys.platform.startswith('aix')``.
Michael Felt9d949f72019-04-12 16:15:32 +02001830 (Contributed by M. Felt in :issue:`36588`.)
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001831
Joannah Nanjekyef781d202019-04-29 04:38:45 -04001832* :c:func:`PyEval_AcquireLock` and :c:func:`PyEval_AcquireThread` now
1833 terminate the current thread if called while the interpreter is
1834 finalizing, making them consistent with :c:func:`PyEval_RestoreThread`,
1835 :c:func:`Py_END_ALLOW_THREADS`, and :c:func:`PyGILState_Ensure`. If this
Raymond Hettingera3291532019-10-13 23:32:03 -07001836 behavior is not desired, guard the call by checking :c:func:`_Py_IsFinalizing`
Joannah Nanjekyef781d202019-04-29 04:38:45 -04001837 or :c:func:`sys.is_finalizing`.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001838 (Contributed by Joannah Nanjekye in :issue:`36475`.)
1839
Joannah Nanjekyef781d202019-04-29 04:38:45 -04001840
Serhiy Storchaka97f1ca12018-02-01 18:49:21 +02001841Changes in the Python API
1842-------------------------
1843
Victor Stinner689830e2019-06-26 17:31:12 +02001844* The :func:`os.getcwdb` function now uses the UTF-8 encoding on Windows,
1845 rather than the ANSI code page: see :pep:`529` for the rationale. The
1846 function is no longer deprecated on Windows.
1847 (Contributed by Victor Stinner in :issue:`37412`.)
1848
Victor Stinnerd7befad2019-04-25 14:30:16 +02001849* :class:`subprocess.Popen` can now use :func:`os.posix_spawn` in some cases
1850 for better performance. On Windows Subsystem for Linux and QEMU User
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001851 Emulation, the :class:`Popen` constructor using :func:`os.posix_spawn` no longer raises an
1852 exception on errors like "missing program". Instead the child process fails with a
Victor Stinnerd7befad2019-04-25 14:30:16 +02001853 non-zero :attr:`~Popen.returncode`.
Victor Stinner01ae8972019-06-03 16:28:01 +02001854 (Contributed by Joannah Nanjekye and Victor Stinner in :issue:`35537`.)
Victor Stinnerd7befad2019-04-25 14:30:16 +02001855
Christian Heimes98d90f72019-08-27 23:36:56 +02001856* The *preexec_fn* argument of * :class:`subprocess.Popen` is no longer
1857 compatible with subinterpreters. The use of the parameter in a
1858 subinterpreter now raises :exc:`RuntimeError`.
1859 (Contributed by Eric Snow in :issue:`34651`, modified by Christian Heimes
1860 in :issue:`37951`.)
1861
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001862* The :meth:`imap.IMAP4.logout` method no longer silently ignores arbitrary
Victor Stinner74125a62019-04-15 18:23:20 +02001863 exceptions.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001864 (Contributed by Victor Stinner in :issue:`36348`.)
Victor Stinner74125a62019-04-15 18:23:20 +02001865
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001866* The function :func:`platform.popen` has been removed, after having been deprecated since
Victor Stinner73104fa2018-11-29 09:58:20 +01001867 Python 3.3: use :func:`os.popen` instead.
Victor Stinner01ae8972019-06-03 16:28:01 +02001868 (Contributed by Victor Stinner in :issue:`35345`.)
Victor Stinner73104fa2018-11-29 09:58:20 +01001869
Raymond Hettingerfc06a192019-03-12 00:43:27 -07001870* The :func:`statistics.mode` function no longer raises an exception
1871 when given multimodal data. Instead, it returns the first mode
1872 encountered in the input data. (Contributed by Raymond Hettinger
1873 in :issue:`35892`.)
1874
Serhiy Storchaka97f1ca12018-02-01 18:49:21 +02001875* The :meth:`~tkinter.ttk.Treeview.selection` method of the
1876 :class:`tkinter.ttk.Treeview` class no longer takes arguments. Using it with
1877 arguments for changing the selection was deprecated in Python 3.6. Use
1878 specialized methods like :meth:`~tkinter.ttk.Treeview.selection_set` for
1879 changing the selection. (Contributed by Serhiy Storchaka in :issue:`31508`.)
Serhiy Storchaka6c85efa52018-02-05 22:47:31 +02001880
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001881* The :meth:`writexml`, :meth:`toxml` and :meth:`toprettyxml` methods of
1882 :mod:`xml.dom.minidom`, and the :meth:`write` method of :mod:`xml.etree`,
1883 now preserve the attribute order specified by the user.
Diego Rojas06e1e682019-03-16 18:44:56 -05001884 (Contributed by Diego Rojas and Raymond Hettinger in :issue:`34160`.)
1885
Serhiy Storchaka6c85efa52018-02-05 22:47:31 +02001886* A :mod:`dbm.dumb` database opened with flags ``'r'`` is now read-only.
1887 :func:`dbm.dumb.open` with flags ``'r'`` and ``'w'`` no longer creates
1888 a database if it does not exist.
1889 (Contributed by Serhiy Storchaka in :issue:`32749`.)
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001890
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001891* The ``doctype()`` method defined in a subclass of
1892 :class:`~xml.etree.ElementTree.XMLParser` will no longer be called and will
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001893 emit a :exc:`RuntimeWarning` instead of a :exc:`DeprecationWarning`.
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001894 Define the :meth:`doctype() <xml.etree.ElementTree.TreeBuilder.doctype>`
1895 method on a target for handling an XML doctype declaration.
1896 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1897
Serhiy Storchakaf5e7b192018-05-20 08:48:12 +03001898* A :exc:`RuntimeError` is now raised when the custom metaclass doesn't
1899 provide the ``__classcell__`` entry in the namespace passed to
1900 ``type.__new__``. A :exc:`DeprecationWarning` was emitted in Python
1901 3.6--3.7. (Contributed by Serhiy Storchaka in :issue:`23722`.)
1902
Scott Sandersoncebe80b2018-06-07 05:46:42 -04001903* The :class:`cProfile.Profile` class can now be used as a context
1904 manager. (Contributed by Scott Sanderson in :issue:`29235`.)
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001905
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07001906* :func:`shutil.copyfile`, :func:`shutil.copy`, :func:`shutil.copy2`,
1907 :func:`shutil.copytree` and :func:`shutil.move` use platform-specific
1908 "fast-copy" syscalls (see
1909 :ref:`shutil-platform-dependent-efficient-copy-operations` section).
1910
1911* :func:`shutil.copyfile` default buffer size on Windows was changed from
1912 16 KiB to 1 MiB.
1913
Raymond Hettinger4f9ffc92019-08-05 13:33:19 -07001914* The ``PyGC_Head`` struct has changed completely. All code that touched the
Hugo van Kemenade547c60c2019-10-12 20:53:36 +03001915 struct member should be rewritten. (See :issue:`33597`.)
INADA Naokid5c875b2018-07-11 17:42:49 +09001916
Raymond Hettingerc93883c2019-10-20 11:25:16 -07001917* The :c:type:`PyInterpreterState` struct has been moved into the "internal"
Eric Snowbe3b2952019-02-23 11:35:52 -07001918 header files (specifically Include/internal/pycore_pystate.h). An
1919 opaque ``PyInterpreterState`` is still available as part of the public
1920 API (and stable ABI). The docs indicate that none of the struct's
1921 fields are public, so we hope no one has been using them. However,
1922 if you do rely on one or more of those private fields and have no
1923 alternative then please open a BPO issue. We'll work on helping
1924 you adjust (possibly including adding accessor functions to the
1925 public API). (See :issue:`35886`.)
1926
Berker Peksage7d4b2f2018-08-22 21:21:05 +03001927* The :meth:`mmap.flush() <mmap.mmap.flush>` method now returns ``None`` on
1928 success and raises an exception on error under all platforms. Previously,
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001929 its behavior was platform-dependent: a nonzero value was returned on success;
Berker Peksage7d4b2f2018-08-22 21:21:05 +03001930 zero was returned on error under Windows. A zero value was returned on
1931 success; an exception was raised on error under Unix.
1932 (Contributed by Berker Peksag in :issue:`2122`.)
1933
Andrés Delfinoca682612018-11-07 14:29:14 -03001934* :mod:`xml.dom.minidom` and :mod:`xml.sax` modules no longer process
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001935 external entities by default.
1936 (Contributed by Christian Heimes in :issue:`17239`.)
INADA Naokid5c875b2018-07-11 17:42:49 +09001937
Xiang Zhang4fb0b8b2018-12-12 20:46:55 +08001938* Deleting a key from a read-only :mod:`dbm` database (:mod:`dbm.dumb`,
1939 :mod:`dbm.gnu` or :mod:`dbm.ndbm`) raises :attr:`error` (:exc:`dbm.dumb.error`,
1940 :exc:`dbm.gnu.error` or :exc:`dbm.ndbm.error`) instead of :exc:`KeyError`.
1941 (Contributed by Xiang Zhang in :issue:`33106`.)
1942
Steve Dower8ef864d2019-03-12 15:15:26 -07001943* :func:`~os.path.expanduser` on Windows now prefers the :envvar:`USERPROFILE`
1944 environment variable and does not use :envvar:`HOME`, which is not normally
1945 set for regular user accounts.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001946 (Contributed by Anthony Sottile in :issue:`36264`.)
Steve Dower8ef864d2019-03-12 15:15:26 -07001947
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001948* The exception :class:`asyncio.CancelledError` now inherits from
Kyle Stanley3bbb6db2019-10-24 00:15:25 -04001949 :class:`BaseException` rather than :class:`Exception`.
1950 (Contributed by Yury Selivanov in :issue:`32528`.)
1951
1952* The function :func:`asyncio.wait_for` now correctly waits for cancellation
1953 when using an instance of :class:`asyncio.Task`. Previously, upon reaching
1954 *timeout*, it was cancelled and immediately returned.
1955 (Contributed by Elvis Pranskevichus in :issue:`32751`.)
1956
1957* The function :func:`asyncio.BaseTransport.get_extra_info` now returns a safe
1958 to use socket object when 'socket' is passed to the *name* parameter.
1959 (Contributed by Yury Selivanov in :issue:`37027`.)
1960
1961* :class:`asyncio.BufferedProtocol` has graduated to the stable API.
Phil Jonese634da22019-10-12 17:46:13 +00001962
Steve Dower2438cdf2019-03-29 16:37:16 -07001963.. _bpo-36085-whatsnew:
1964
1965* DLL dependencies for extension modules and DLLs loaded with :mod:`ctypes` on
1966 Windows are now resolved more securely. Only the system paths, the directory
1967 containing the DLL or PYD file, and directories added with
1968 :func:`~os.add_dll_directory` are searched for load-time dependencies.
1969 Specifically, :envvar:`PATH` and the current working directory are no longer
1970 used, and modifications to these will no longer have any effect on normal DLL
1971 resolution. If your application relies on these mechanisms, you should check
1972 for :func:`~os.add_dll_directory` and if it exists, use it to add your DLLs
Steve Dower79da3882019-03-30 20:58:17 -07001973 directory while loading your library. Note that Windows 7 users will need to
benedwards14794616f2019-10-28 17:53:51 +00001974 ensure that Windows Update KB2533623 has been installed (this is also verified
Steve Dower79da3882019-03-30 20:58:17 -07001975 by the installer).
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001976 (Contributed by Steve Dower in :issue:`36085`.)
Steve Dower2438cdf2019-03-29 16:37:16 -07001977
Pablo Galindof2cf1e32019-04-13 17:05:14 +01001978* The header files and functions related to pgen have been removed after its
1979 replacement by a pure Python implementation. (Contributed by Pablo Galindo
1980 in :issue:`36623`.)
1981
Pablo Galindo5d23e282019-05-12 22:45:52 +01001982* :class:`types.CodeType` has a new parameter in the second position of the
1983 constructor (*posonlyargcount*) to support positional-only arguments defined
Pablo Galindocd74e662019-06-01 18:08:04 +01001984 in :pep:`570`. The first argument (*argcount*) now represents the total
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001985 number of positional arguments (including positional-only arguments). The new
Pablo Galindocd74e662019-06-01 18:08:04 +01001986 ``replace()`` method of :class:`types.CodeType` can be used to make the code
1987 future-proof.
Pablo Galindo5d23e282019-05-12 22:45:52 +01001988
Xiang Zhang4fb0b8b2018-12-12 20:46:55 +08001989
Inada Naokid3c72a22019-03-23 21:04:40 +09001990Changes in the C API
1991--------------------
1992
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001993* The :c:type:`PyCompilerFlags` structure got a new *cf_feature_version*
Victor Stinner2c9b4982019-06-13 02:01:29 +02001994 field. It should be initialized to ``PY_MINOR_VERSION``. The field is ignored
Andrew Kuchlingbb78f6c2019-10-13 11:51:36 -04001995 by default, and is used if and only if ``PyCF_ONLY_AST`` flag is set in
Victor Stinner2c9b4982019-06-13 02:01:29 +02001996 *cf_flags*.
Serhiy Storchaka298439c2019-10-14 16:10:40 +03001997 (Contributed by Guido van Rossum in :issue:`35766`.)
Victor Stinner2c9b4982019-06-13 02:01:29 +02001998
Victor Stinnerd5d9e812019-05-13 12:35:37 +02001999* The :c:func:`PyEval_ReInitThreads` function has been removed from the C API.
2000 It should not be called explicitly: use :c:func:`PyOS_AfterFork_Child`
2001 instead.
2002 (Contributed by Victor Stinner in :issue:`36728`.)
2003
E. M. Brayc994c8f2019-05-24 17:33:47 +02002004* On Unix, C extensions are no longer linked to libpython except on Android
2005 and Cygwin. When Python is embedded, ``libpython`` must not be loaded with
xdegaye254b3092019-04-29 09:27:40 +02002006 ``RTLD_LOCAL``, but ``RTLD_GLOBAL`` instead. Previously, using
E. M. Brayc994c8f2019-05-24 17:33:47 +02002007 ``RTLD_LOCAL``, it was already not possible to load C extensions which
2008 were not linked to ``libpython``, like C extensions of the standard
2009 library built by the ``*shared*`` section of ``Modules/Setup``.
Victor Stinner01ae8972019-06-03 16:28:01 +02002010 (Contributed by Victor Stinner in :issue:`21536`.)
Victor Stinner8c3ecc62019-04-25 20:13:10 +02002011
Inada Naokid3c72a22019-03-23 21:04:40 +09002012* Use of ``#`` variants of formats in parsing or building value (e.g.
2013 :c:func:`PyArg_ParseTuple`, :c:func:`Py_BuildValue`, :c:func:`PyObject_CallFunction`,
2014 etc.) without ``PY_SSIZE_T_CLEAN`` defined raises ``DeprecationWarning`` now.
2015 It will be removed in 3.10 or 4.0. Read :ref:`arg-parsing` for detail.
2016 (Contributed by Inada Naoki in :issue:`36381`.)
2017
Eddie Elizondo364f0b02019-03-27 07:52:18 -04002018* Instances of heap-allocated types (such as those created with
2019 :c:func:`PyType_FromSpec`) hold a reference to their type object.
2020 Increasing the reference count of these type objects has been moved from
2021 :c:func:`PyType_GenericAlloc` to the more low-level functions,
2022 :c:func:`PyObject_Init` and :c:func:`PyObject_INIT`.
2023 This makes types created through :c:func:`PyType_FromSpec` behave like
2024 other classes in managed code.
2025
2026 Statically allocated types are not affected.
2027
2028 For the vast majority of cases, there should be no side effect.
2029 However, types that manually increase the reference count after allocating
2030 an instance (perhaps to work around the bug) may now become immortal.
2031 To avoid this, these classes need to call Py_DECREF on the type object
2032 during instance deallocation.
2033
2034 To correctly port these types into 3.8, please apply the following
2035 changes:
2036
2037 * Remove :c:macro:`Py_INCREF` on the type object after allocating an
2038 instance - if any.
2039 This may happen after calling :c:func:`PyObject_New`,
2040 :c:func:`PyObject_NewVar`, :c:func:`PyObject_GC_New`,
2041 :c:func:`PyObject_GC_NewVar`, or any other custom allocator that uses
2042 :c:func:`PyObject_Init` or :c:func:`PyObject_INIT`.
2043
Serhiy Storchaka298439c2019-10-14 16:10:40 +03002044 Example:
2045
2046 .. code-block:: c
Eddie Elizondo364f0b02019-03-27 07:52:18 -04002047
2048 static foo_struct *
2049 foo_new(PyObject *type) {
2050 foo_struct *foo = PyObject_GC_New(foo_struct, (PyTypeObject *) type);
2051 if (foo == NULL)
2052 return NULL;
2053 #if PY_VERSION_HEX < 0x03080000
2054 // Workaround for Python issue 35810; no longer necessary in Python 3.8
2055 PY_INCREF(type)
2056 #endif
2057 return foo;
2058 }
2059
2060 * Ensure that all custom ``tp_dealloc`` functions of heap-allocated types
2061 decrease the type's reference count.
2062
Serhiy Storchaka298439c2019-10-14 16:10:40 +03002063 Example:
2064
2065 .. code-block:: c
Eddie Elizondo364f0b02019-03-27 07:52:18 -04002066
2067 static void
2068 foo_dealloc(foo_struct *instance) {
2069 PyObject *type = Py_TYPE(instance);
2070 PyObject_GC_Del(instance);
2071 #if PY_VERSION_HEX >= 0x03080000
2072 // This was not needed before Python 3.8 (Python issue 35810)
2073 Py_DECREF(type);
2074 #endif
2075 }
2076
2077 (Contributed by Eddie Elizondo in :issue:`35810`.)
2078
Zackery Spytz3c8724f2019-05-28 09:16:33 -06002079* The :c:macro:`Py_DEPRECATED()` macro has been implemented for MSVC.
2080 The macro now must be placed before the symbol name.
2081
Serhiy Storchaka298439c2019-10-14 16:10:40 +03002082 Example:
2083
2084 .. code-block:: c
Zackery Spytz3c8724f2019-05-28 09:16:33 -06002085
2086 Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);
2087
2088 (Contributed by Zackery Spytz in :issue:`33407`.)
2089
Antoine Pitrouada319b2019-05-29 22:12:38 +02002090* The interpreter does not pretend to support binary compatibility of
Xtreak0d702272019-06-03 04:42:33 +05302091 extension types across feature releases, anymore. A :c:type:`PyTypeObject`
Antoine Pitrouada319b2019-05-29 22:12:38 +02002092 exported by a third-party extension module is supposed to have all the
2093 slots expected in the current Python version, including
2094 :c:member:`~PyTypeObject.tp_finalize` (:const:`Py_TPFLAGS_HAVE_FINALIZE`
2095 is not checked anymore before reading :c:member:`~PyTypeObject.tp_finalize`).
2096
2097 (Contributed by Antoine Pitrou in :issue:`32388`.)
2098
Pablo Galindo545a3b82019-05-31 19:33:41 +01002099* The :c:func:`PyCode_New` has a new parameter in the second position (*posonlyargcount*)
2100 to support :pep:`570`, indicating the number of positional-only arguments.
2101
Ivan Levkivskyi47c2de72019-06-19 01:17:47 +01002102* The functions :c:func:`PyNode_AddChild` and :c:func:`PyParser_AddToken` now accept
2103 two additional ``int`` arguments *end_lineno* and *end_col_offset*.
Eddie Elizondo364f0b02019-03-27 07:52:18 -04002104
Steve Dowerf5690922019-06-21 14:28:46 -07002105* The :file:`libpython38.a` file to allow MinGW tools to link directly against
2106 :file:`python38.dll` is no longer included in the regular Windows distribution.
2107 If you require this file, it may be generated with the ``gendef`` and
Serhiy Storchaka298439c2019-10-14 16:10:40 +03002108 ``dlltool`` tools, which are part of the MinGW binutils package:
2109
2110 .. code-block:: shell
Steve Dowerf5690922019-06-21 14:28:46 -07002111
2112 gendef python38.dll > tmp.def
2113 dlltool --dllname python38.dll --def tmp.def --output-lib libpython38.a
2114
2115 The location of an installed :file:`pythonXY.dll` will depend on the
2116 installation options and the version and language of Windows. See
2117 :ref:`using-on-windows` for more information. The resulting library should be
2118 placed in the same directory as :file:`pythonXY.lib`, which is generally the
2119 :file:`libs` directory under your Python installation.
2120
Serhiy Storchaka298439c2019-10-14 16:10:40 +03002121 (Contributed by Steve Dower in :issue:`37351`.)
Steve Dowerf5690922019-06-21 14:28:46 -07002122
2123
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02002124CPython bytecode changes
2125------------------------
2126
2127* The interpreter loop has been simplified by moving the logic of unrolling
2128 the stack of blocks into the compiler. The compiler emits now explicit
Serhiy Storchaka3f819ca2018-10-31 02:26:06 +02002129 instructions for adjusting the stack of values and calling the
2130 cleaning-up code for :keyword:`break`, :keyword:`continue` and
2131 :keyword:`return`.
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02002132
2133 Removed opcodes :opcode:`BREAK_LOOP`, :opcode:`CONTINUE_LOOP`,
2134 :opcode:`SETUP_LOOP` and :opcode:`SETUP_EXCEPT`. Added new opcodes
2135 :opcode:`ROT_FOUR`, :opcode:`BEGIN_FINALLY`, :opcode:`CALL_FINALLY` and
2136 :opcode:`POP_FINALLY`. Changed the behavior of :opcode:`END_FINALLY`
2137 and :opcode:`WITH_CLEANUP_START`.
2138
2139 (Contributed by Mark Shannon, Antoine Pitrou and Serhiy Storchaka in
2140 :issue:`17611`.)
Serhiy Storchaka702f8f32018-03-23 14:34:35 +02002141
2142* Added new opcode :opcode:`END_ASYNC_FOR` for handling exceptions raised
2143 when awaiting a next item in an :keyword:`async for` loop.
2144 (Contributed by Serhiy Storchaka in :issue:`33041`.)
Raymond Hettingerf75d59e2019-02-02 22:54:56 -08002145
Pablo Galindob51b7132019-06-25 02:41:58 +01002146* The :opcode:`MAP_ADD` now expects the value as the first element in the
2147 stack and the key as the second element. This change was made so the key
2148 is always evaluated before the value in dictionary comprehensions, as
Pablo Galindode9b6062019-06-25 11:55:23 +01002149 proposed by :pep:`572`. (Contributed by Jörn Heissler in :issue:`35224`.)
Pablo Galindob51b7132019-06-25 02:41:58 +01002150
Raymond Hettingerf75d59e2019-02-02 22:54:56 -08002151
2152Demos and Tools
2153---------------
2154
Raymond Hettinger1cdadf42019-11-03 21:47:01 -08002155Added a benchmark script for timing various ways to access variables:
2156``Tools/scripts/var_access_benchmark.py``.
2157(Contributed by Raymond Hettinger in :issue:`35884`.)
2158
2159Here's a summary of performance improvements since Python 3.3:
2160
2161.. code-block:: none
2162
2163 Python version 3.3 3.4 3.5 3.6 3.7 3.8
2164 -------------- --- --- --- --- --- ---
2165
2166 Variable and attribute read access:
2167 read_local 4.0 7.1 7.1 5.4 5.1 3.9
2168 read_nonlocal 5.3 7.1 8.1 5.8 5.4 4.4
2169 read_global 13.3 15.5 19.0 14.3 13.6 7.6
2170 read_builtin 20.0 21.1 21.6 18.5 19.0 7.5
2171 read_classvar_from_class 20.5 25.6 26.5 20.7 19.5 18.4
2172 read_classvar_from_instance 18.5 22.8 23.5 18.8 17.1 16.4
2173 read_instancevar 26.8 32.4 33.1 28.0 26.3 25.4
2174 read_instancevar_slots 23.7 27.8 31.3 20.8 20.8 20.2
2175 read_namedtuple 68.5 73.8 57.5 45.0 46.8 18.4
2176 read_boundmethod 29.8 37.6 37.9 29.6 26.9 27.7
2177
2178 Variable and attribute write access:
2179 write_local 4.6 8.7 9.3 5.5 5.3 4.3
2180 write_nonlocal 7.3 10.5 11.1 5.6 5.5 4.7
2181 write_global 15.9 19.7 21.2 18.0 18.0 15.8
2182 write_classvar 81.9 92.9 96.0 104.6 102.1 39.2
2183 write_instancevar 36.4 44.6 45.8 40.0 38.9 35.5
2184 write_instancevar_slots 28.7 35.6 36.1 27.3 26.6 25.7
2185
2186 Data structure read access:
2187 read_list 19.2 24.2 24.5 20.8 20.8 19.0
2188 read_deque 19.9 24.7 25.5 20.2 20.6 19.8
2189 read_dict 19.7 24.3 25.7 22.3 23.0 21.0
2190 read_strdict 17.9 22.6 24.3 19.5 21.2 18.9
2191
2192 Data structure write access:
2193 write_list 21.2 27.1 28.5 22.5 21.6 20.0
2194 write_deque 23.8 28.7 30.1 22.7 21.8 23.5
2195 write_dict 25.9 31.4 33.3 29.3 29.2 24.7
2196 write_strdict 22.9 28.4 29.9 27.5 25.2 23.1
2197
2198 Stack (or queue) operations:
2199 list_append_pop 144.2 93.4 112.7 75.4 74.2 50.8
2200 deque_append_pop 30.4 43.5 57.0 49.4 49.2 42.5
2201 deque_append_popleft 30.8 43.7 57.3 49.7 49.7 42.8
2202
2203 Timing loop:
2204 loop_overhead 0.3 0.5 0.6 0.4 0.3 0.3
2205
2206 (Measured from the macOS 64-bit builds found at python.org)