blob: 8442e4ef2e3c7fe25d19a2969fe7168c0b2d7cd9 [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
42 This saves the maintainer the effort of going through the Mercurial log
43 when researching a change.
44
45This article explains the new features in Python 3.8, compared to 3.7.
46
Ned Deily45ab51c2018-02-28 13:58:38 -050047For full details, see the :ref:`changelog <changelog>`.
Ned Deily07a18922018-01-31 18:12:38 -050048
49.. note::
50
51 Prerelease users should be aware that this document is currently in draft
52 form. It will be updated substantially as Python 3.8 moves towards release,
53 so it's worth checking back even after reading earlier versions.
54
Nick Coghlanb9438ce2019-06-09 19:07:42 +100055 Some notable items not yet covered here:
56
Nick Coghlanb9438ce2019-06-09 19:07:42 +100057 * :pep:`578` - Runtime audit hooks for potentially sensitive operations
58 * ``python -m asyncio`` runs a natively async REPL
59 * ...
60
Ned Deily07a18922018-01-31 18:12:38 -050061
62Summary -- Release highlights
63=============================
64
65.. This section singles out the most important changes in Python 3.8.
66 Brevity is key.
67
68
69.. PEP-sized items next.
70
71
72
73New Features
74============
75
Guido van Rossum09d434c2019-04-24 11:30:17 -070076Assignment expressions
77----------------------
78
79There is new syntax (the "walrus operator", ``:=``) to assign values
80to variables as part of an expression. Example::
81
82 if (n := len(a)) > 10:
83 print(f"List is too long ({n} elements, expected <= 10)")
84
85See :pep:`572` for a full description.
86
87(Contributed by Emily Morehouse in :issue:`35224`.)
88
89.. TODO: Emily will sprint on docs at PyCon US 2019.
90
91
Guido van Rossum843bf422019-04-29 05:49:30 -070092Positional-only parameters
93--------------------------
94
95There is new syntax (``/``) to indicate that some function parameters
96must be specified positionally (i.e., cannot be used as keyword
97arguments). This is the same notation as shown by ``help()`` for
98functions implemented in C (produced by Larry Hastings' "Argument
99Clinic" tool). Example::
100
101 def pow(x, y, z=None, /):
102 r = x**y
103 if z is not None:
104 r %= z
105 return r
106
107Now ``pow(2, 10)`` and ``pow(2, 10, 17)`` are valid calls, but
108``pow(x=2, y=10)`` and ``pow(2, 10, z=17)`` are invalid.
109
110See :pep:`570` for a full description.
111
112(Contributed by Pablo Galindo in :issue:`36540`.)
113
114.. TODO: Pablo will sprint on docs at PyCon US 2019.
115
116
Nick Coghlan16eb3bc2018-06-20 21:25:01 +1000117Parallel filesystem cache for compiled bytecode files
118-----------------------------------------------------
119
120The new :envvar:`PYTHONPYCACHEPREFIX` setting (also available as
121:option:`-X` ``pycache_prefix``) configures the implicit bytecode
122cache to use a separate parallel filesystem tree, rather than
123the default ``__pycache__`` subdirectories within each source
124directory.
125
126The location of the cache is reported in :data:`sys.pycache_prefix`
127(:const:`None` indicates the default location in ``__pycache__``
128subdirectories).
129
130(Contributed by Carl Meyer in :issue:`33499`.)
Ned Deily07a18922018-01-31 18:12:38 -0500131
Victor Stinner40460692019-04-26 17:56:44 +0200132Debug build uses the same ABI as release build
133-----------------------------------------------
134
Paul Ganssle5c403b22019-04-27 14:14:35 -0400135Python now uses the same ABI whether it built in release or debug mode. On
136Unix, when Python is built in debug mode, it is now possible to load C
137extensions built in release mode and C extensions built using the stable ABI.
Victor Stinner40460692019-04-26 17:56:44 +0200138
Paul Ganssle5c403b22019-04-27 14:14:35 -0400139Release builds and debug builds are now ABI compatible: defining the
140``Py_DEBUG`` macro no longer implies the ``Py_TRACE_REFS`` macro, which
141introduces the only ABI incompatibility. The ``Py_TRACE_REFS`` macro, which
142adds the :func:`sys.getobjects` function and the :envvar:`PYTHONDUMPREFS`
143environment variable, can be set using the new ``./configure --with-trace-refs``
144build option.
Victor Stinner40460692019-04-26 17:56:44 +0200145(Contributed by Victor Stinner in :issue:`36465`.)
146
E. M. Brayc994c8f2019-05-24 17:33:47 +0200147On Unix, C extensions are no longer linked to libpython except on Android
148and Cygwin.
Victor Stinner4ebcd7e2019-05-11 04:10:03 +0200149It is now possible
Paul Ganssle5c403b22019-04-27 14:14:35 -0400150for a statically linked Python to load a C extension built using a shared
151library Python.
Victor Stinner40460692019-04-26 17:56:44 +0200152(Contributed by Victor Stinner in :issue:`21536`.)
153
154On Unix, when Python is built in debug mode, import now also looks for C
155extensions compiled in release mode and for C extensions compiled with the
156stable ABI.
157(Contributed by Victor Stinner in :issue:`36722`.)
158
Victor Stinner0a8e5722019-05-23 03:30:23 +0200159To embed Python into an application, a new ``--embed`` option must be passed to
160``python3-config --libs --embed`` to get ``-lpython3.8`` (link the application
161to libpython). To support both 3.8 and older, try ``python3-config --libs
162--embed`` first and fallback to ``python3-config --libs`` (without ``--embed``)
163if the previous command fails.
164
165Add a pkg-config ``python-3.8-embed`` module to embed Python into an
166application: ``pkg-config python-3.8-embed --libs`` includes ``-lpython3.8``.
167To support both 3.8 and older, try ``pkg-config python-X.Y-embed --libs`` first
168and fallback to ``pkg-config python-X.Y --libs`` (without ``--embed``) if the
169previous command fails (replace ``X.Y`` with the Python version).
170
171On the other hand, ``pkg-config python3.8 --libs`` no longer contains
172``-lpython3.8``. C extensions must not be linked to libpython (except on
E. M. Brayc994c8f2019-05-24 17:33:47 +0200173Android and Cygwin, whose cases are handled by the script);
174this change is backward incompatible on purpose.
Victor Stinner0a8e5722019-05-23 03:30:23 +0200175(Contributed by Victor Stinner in :issue:`36721`.)
176
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400177f-strings now support = for quick and easy debugging
178-----------------------------------------------------
179
180Add ``=`` specifier to f-strings. ``f'{expr=}'`` expands
181to the text of the expression, an equal sign, then the repr of the
182evaluated expression. So::
183
184 x = 3
185 print(f'{x*9 + 15=}')
186
187Would print ``x*9 + 15=42``.
188
189(Contributed by Eric V. Smith and Larry Hastings in :issue:`36817`.)
190
Victor Stinner331a6a52019-05-27 16:39:22 +0200191PEP 587: Python Initialization Configuration
192--------------------------------------------
193
194The :pep:`587` adds a new C API to configure the Python Initialization
195providing finer control on the whole configuration and better error reporting.
196
197New structures:
198
199* :c:type:`PyConfig`
200* :c:type:`PyPreConfig`
201* :c:type:`PyStatus`
202* :c:type:`PyWideStringList`
203
204New functions:
205
206* :c:func:`PyConfig_Clear`
207* :c:func:`PyConfig_InitIsolatedConfig`
208* :c:func:`PyConfig_InitPythonConfig`
209* :c:func:`PyConfig_Read`
210* :c:func:`PyConfig_SetArgv`
211* :c:func:`PyConfig_SetBytesArgv`
212* :c:func:`PyConfig_SetBytesString`
213* :c:func:`PyConfig_SetString`
214* :c:func:`PyPreConfig_InitIsolatedConfig`
215* :c:func:`PyPreConfig_InitPythonConfig`
216* :c:func:`PyStatus_Error`
217* :c:func:`PyStatus_Exception`
218* :c:func:`PyStatus_Exit`
219* :c:func:`PyStatus_IsError`
220* :c:func:`PyStatus_IsExit`
221* :c:func:`PyStatus_NoMemory`
222* :c:func:`PyStatus_Ok`
223* :c:func:`PyWideStringList_Append`
224* :c:func:`PyWideStringList_Insert`
225* :c:func:`Py_BytesMain`
226* :c:func:`Py_ExitStatusException`
227* :c:func:`Py_InitializeFromConfig`
228* :c:func:`Py_PreInitialize`
229* :c:func:`Py_PreInitializeFromArgs`
230* :c:func:`Py_PreInitializeFromBytesArgs`
231* :c:func:`Py_RunMain`
232
233This PEP also adds ``_PyRuntimeState.preconfig`` (:c:type:`PyPreConfig` type)
234and ``PyInterpreterState.config`` (:c:type:`PyConfig` type) fields to these
235internal structures. ``PyInterpreterState.config`` becomes the new
236reference configuration, replacing global configuration variables and
237other private variables.
238
239See :ref:`Python Initialization Configuration <init-config>` for the
240documentation.
241
242See :pep:`587` for a full description.
243
244(Contributed by Victor Stinner in :issue:`36763`.)
245
Ned Deily07a18922018-01-31 18:12:38 -0500246
Jeroen Demeyer9e3e06e2019-06-03 01:43:13 +0200247Vectorcall: a fast calling protocol for CPython
248-----------------------------------------------
249
250The "vectorcall" protocol is added to the Python/C API.
251It is meant to formalize existing optimizations which were already done
252for various classes.
253Any extension type implementing a callable can use this protocol.
254
255This is currently provisional,
256the aim is to make it fully public in Python 3.9.
257
258See :pep:`590` for a full description.
259
260(Contributed by Jeroen Demeyer and Mark Shannon in :issue:`36974`.)
261
262
Antoine Pitrouc879ff22019-06-09 14:47:15 +0200263Pickle protocol 5 with out-of-band data buffers
264-----------------------------------------------
265
266When :mod:`pickle` is used to transfer large data between Python processes
267in order to take advantage of multi-core or multi-machine processing,
268it is important to optimize the transfer by reducing memory copies, and
269possibly by applying custom techniques such as data-dependent compression.
270
271The :mod:`pickle` protocol 5 introduces support for out-of-band buffers
272where :pep:`3118`-compatible data can be transmitted separately from the
273main pickle stream, at the discretion of the communication layer.
274
275See :pep:`574` for a full description.
276
277(Contributed by Antoine Pitrou in :issue:`36785`.)
278
279
Ned Deily07a18922018-01-31 18:12:38 -0500280Other Language Changes
281======================
282
Serhiy Storchakafe2bbb12018-03-18 09:56:52 +0200283* A :keyword:`continue` statement was illegal in the :keyword:`finally` clause
284 due to a problem with the implementation. In Python 3.8 this restriction
285 was lifted.
286 (Contributed by Serhiy Storchaka in :issue:`32489`.)
287
Serhiy Storchakab2e20252018-10-20 00:46:31 +0300288* The :class:`int` type now has a new :meth:`~int.as_integer_ratio` method
289 compatible with the existing :meth:`float.as_integer_ratio` method.
Lisa Roach5ac70432018-09-13 23:56:23 -0700290 (Contributed by Lisa Roach in :issue:`33073`.)
291
Serhiy Storchakabdbad712019-06-02 00:05:48 +0300292* Constructors of :class:`int`, :class:`float` and :class:`complex` will now
293 use the :meth:`~object.__index__` special method, if available and the
294 corresponding method :meth:`~object.__int__`, :meth:`~object.__float__`
295 or :meth:`~object.__complex__` is not available.
296 (Contributed by Serhiy Storchaka in :issue:`20092`.)
297
Serhiy Storchakaa445feb2018-02-10 00:08:17 +0200298* Added support of ``\N{name}`` escapes in :mod:`regular expressions <re>`.
299 (Contributed by Jonathan Eunice and Serhiy Storchaka in :issue:`30688`.)
Ned Deily07a18922018-01-31 18:12:38 -0500300
Rémi Lapeyre6531bf62018-11-06 01:38:54 +0100301* Dict and dictviews are now iterable in reversed insertion order using
302 :func:`reversed`. (Contributed by Rémi Lapeyre in :issue:`33462`.)
303
Benjamin Petersonc9a71dd2018-09-12 17:14:39 -0700304* The syntax allowed for keyword names in function calls was further
305 restricted. In particular, ``f((keyword)=arg)`` is no longer allowed. It was
306 never intended to permit more than a bare name on the left-hand side of a
307 keyword argument assignment term. See :issue:`34641`.
Ned Deily07a18922018-01-31 18:12:38 -0500308
jChapman8fabae32018-09-22 21:13:10 -0400309* Iterable unpacking is now allowed without parentheses in :keyword:`yield`
310 and :keyword:`return` statements.
311 (Contributed by David Cuthbert and Jordan Chapman in :issue:`32117`.)
312
Serhiy Storchaka65439122018-10-19 17:42:06 +0300313* A backslash-character pair that is not a valid escape sequence generates
314 a :exc:`DeprecationWarning` since Python 3.6. In Python 3.8 it generates
315 a :exc:`SyntaxWarning` instead.
316 (Contributed by Serhiy Storchaka in :issue:`32912`.)
317
Serhiy Storchaka62e44812019-02-16 08:12:19 +0200318* The compiler now produces a :exc:`SyntaxWarning` in some cases when a comma
319 is missed before tuple or list. For example::
320
321 data = [
322 (1, 2, 3) # oops, missing comma!
323 (4, 5, 6)
324 ]
325
326 (Contributed by Serhiy Storchaka in :issue:`15248`.)
327
Paul Ganssled9503c32019-02-08 11:02:00 -0500328* Arithmetic operations between subclasses of :class:`datetime.date` or
329 :class:`datetime.datetime` and :class:`datetime.timedelta` objects now return
330 an instance of the subclass, rather than the base class. This also affects
331 the return type of operations whose implementation (directly or indirectly)
332 uses :class:`datetime.timedelta` arithmetic, such as
333 :meth:`datetime.datetime.astimezone`.
334 (Contributed by Paul Ganssle in :issue:`32417`.)
335
Gregory P. Smith06babb22019-02-23 10:43:49 -0800336* When the Python interpreter is interrupted by Ctrl-C (SIGINT) and the
337 resulting :exc:`KeyboardInterrupt` exception is not caught, the Python process
338 now exits via a SIGINT signal or with the correct exit code such that the
339 calling process can detect that it died due to a Ctrl-C. Shells on POSIX
340 and Windows use this to properly terminate scripts in interactive sessions.
341 (Contributed by Google via Gregory P. Smith in :issue:`1054041`.)
342
Victor Stinnera9f05d62019-05-24 23:57:23 +0200343* Added new ``replace()`` method to the code type (:class:`types.CodeType`).
344 (Contributed by Victor Stinner in :issue:`37032`.)
345
Mark Dickinsonc5299672019-06-02 10:24:06 +0100346* For integers, the three-argument form of the :func:`pow` function now permits
347 the exponent to be negative in the case where the base is relatively prime to
348 the modulus. It then computes a modular inverse to the base when the exponent
349 is ``-1``, and a suitable power of that inverse for other negative exponents.
350 (Contributed by Mark Dickinson in :issue:`36027`.)
351
Pablo Galindob51b7132019-06-25 02:41:58 +0100352* When dictionary comprehensions are evaluated, the key is now evaluated before
353 the value, as proposed by :pep:`572`.
354
Serhiy Storchaka65439122018-10-19 17:42:06 +0300355
Ned Deily07a18922018-01-31 18:12:38 -0500356New Modules
357===========
358
Barry Warsaw4867eaa2019-06-05 19:40:19 -0700359* The new :mod:`importlib.metadata` module provides (provisional) support for
360 reading metadata from third-party packages. For example, you can extract an
361 installed package's version number, list of entry points, and more. See
362 :issue:`34632` for additional details.
Ned Deily07a18922018-01-31 18:12:38 -0500363
364
365Improved Modules
366================
367
Raymond Hettinger0bb4bdf2019-01-31 00:59:50 -0800368
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700369ast
370---
371
372AST nodes now have ``end_lineno`` and ``end_col_offset`` attributes,
373which give the precise location of the end of the node. (This only
374applies to nodes that have ``lineno`` and ``col_offset`` attributes.)
375
376The :func:`ast.parse` function has some new flags:
377
378* ``type_comments=True`` causes it to return the text of :pep:`484` and
379 :pep:`526` type comments associated with certain AST nodes;
380
381* ``mode='func_type'`` can be used to parse :pep:`484` "signature type
382 comments" (returned for function definition AST nodes);
383
Guido van Rossum10b55c12019-06-11 17:23:12 -0700384* ``feature_version=(3, N)`` allows specifying an earlier Python 3
385 version. (For example, ``feature_version=(3, 4)`` will treat
386 ``async`` and ``await`` as non-reserved words.)
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700387
388New function :func:`ast.get_source_segment` returns the source code
389for a specific AST node.
390
391
Victor Stinner6ea29c52018-09-25 08:27:08 -0700392asyncio
393-------
394
395On Windows, the default event loop is now :class:`~asyncio.ProactorEventLoop`.
Victor Stinner01ae8972019-06-03 16:28:01 +0200396(Contributed by Victor Stinner in :issue:`34687`.)
397
398:class:`~asyncio.ProactorEventLoop` now also supports UDP.
399(Contributed by Adam Meily and Andrew Svetlov in :issue:`29883`.)
400
401:class:`~asyncio.ProactorEventLoop` can now be interrupted by
402:exc:`KeyboardInterrupt` ("CTRL+C").
403(Contributed by Vladimir Matveev in :issue:`23057`.)
404
Victor Stinner6ea29c52018-09-25 08:27:08 -0700405
Matthias Bussonnier2ddbd212019-05-22 12:07:45 -0700406builtins
407--------
408
409The :func:`compile` built-in has been improved to accept the
410``ast.PyCF_ALLOW_TOP_LEVEL_AWAIT`` flag. With this new flag passed,
411:func:`compile` will allow top-level ``await``, ``async for`` and ``async with``
412constructs that are usually considered invalid syntax. Asynchronous code object
413marked with the ``CO_COROUTINE`` flag may then be returned.
414
415(Contributed by Matthias Bussonnier in :issue:`34616`)
Terry Jan Reedyfdcb5ae2018-09-25 12:45:27 -0400416
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700417collections
418-----------
419
420The :meth:`_asdict()` method for :func:`collections.namedtuple` now returns
Daniel Porteous05222912019-05-02 04:20:59 -0400421a :class:`dict` instead of a :class:`collections.OrderedDict`. This works because
422regular dicts have guaranteed ordering since Python 3.7. If the extra
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700423features of :class:`OrderedDict` are required, the suggested remediation is
424to cast the result to the desired type: ``OrderedDict(nt._asdict())``.
425(Contributed by Raymond Hettinger in :issue:`35864`.)
426
427
Steve Dower2438cdf2019-03-29 16:37:16 -0700428ctypes
429------
430
431On Windows, :class:`~ctypes.CDLL` and subclasses now accept a *winmode* parameter
432to specify flags for the underlying ``LoadLibraryEx`` call. The default flags are
433set to only load DLL dependencies from trusted locations, including the path
434where the DLL is stored (if a full or partial path is used to load the initial
435DLL) and paths added by :func:`~os.add_dll_directory`.
436
437
Raymond Hettingerb8218682019-05-26 11:27:35 -0700438functools
439---------
440
441:func:`functools.lru_cache` can now be used as a straight decorator rather
442than as a function returning a decorator. So both of these are now supported::
443
444 @lru_cache
445 def f(x):
446 ...
447
448 @lru_cache(maxsize=256)
449 def f(x):
450 ...
451
452(Contributed by Raymond Hettinger in :issue:`36772`.)
453
454
Paul Ganssle88c09372019-04-29 09:22:03 -0400455datetime
456--------
457
458Added new alternate constructors :meth:`datetime.date.fromisocalendar` and
459:meth:`datetime.datetime.fromisocalendar`, which construct :class:`date` and
460:class:`datetime` objects respectively from ISO year, week number and weekday;
461these are the inverse of each class's ``isocalendar`` method.
462(Contributed by Paul Ganssle in :issue:`36004`.)
463
464
Cheryl Sabella637a33b2018-11-07 09:12:20 -0500465gettext
466-------
467
468Added :func:`~gettext.pgettext` and its variants.
469(Contributed by Franz Glasner, Éric Araujo, and Cheryl Sabella in :issue:`2504`.)
470
Raymond Hettingerd1e768a2019-03-25 13:01:13 -0700471inspect
472-------
473
474The :func:`inspect.getdoc` function can now find docstrings for ``__slots__``
475if that attribute is a :class:`dict` where the values are docstrings.
476This provides documentation options similar to what we already have
477for :func:`property`, :func:`classmethod`, and :func:`staticmethod`::
478
479 class AudioClip:
480 __slots__ = {'bit_rate': 'expressed in kilohertz to one decimal place',
481 'duration': 'in seconds, rounded up to an integer'}
482 def __init__(self, bit_rate, duration):
483 self.bit_rate = round(bit_rate / 1000.0, 1)
484 self.duration = ceil(duration)
Pablo Galindo175421b2019-02-23 03:02:06 +0000485
Victor Stinnerbc2aa812019-05-23 03:45:09 +0200486io
487--
488
489In development mode (:option:`-X` ``env``) and in debug build, the
490:class:`io.IOBase` finalizer now logs the exception if the ``close()`` method
491fails. The exception is ignored silently by default in release build.
492(Contributed by Victor Stinner in :issue:`18748`.)
493
494
Pablo Galindo175421b2019-02-23 03:02:06 +0000495gc
496--
497
498:func:`~gc.get_objects` can now receive an optional *generation* parameter
499indicating a generation to get objects from. Contributed in
500:issue:`36016` by Pablo Galindo.
501
502
guoci0e7497c2018-11-07 04:50:23 -0500503gzip
504----
505
506Added the *mtime* parameter to :func:`gzip.compress` for reproducible output.
507(Contributed by Guo Ci Teo in :issue:`34898`.)
508
Zackery Spytzcf599f62019-05-13 01:50:52 -0600509A :exc:`~gzip.BadGzipFile` exception is now raised instead of :exc:`OSError`
510for certain types of invalid or corrupt gzip files.
511(Contributed by Filip Gruszczyński, Michele Orrù, and Zackery Spytz in
512:issue:`6584`.)
513
guoci0e7497c2018-11-07 04:50:23 -0500514
Terry Jan Reedyfdcb5ae2018-09-25 12:45:27 -0400515idlelib and IDLE
516----------------
517
Tal Einat7123ea02019-07-23 15:22:11 +0300518Add optional line numbers for IDLE editor windows. Windows
519open without line numbers unless set otherwise in the General
520tab of the configuration dialog.
521(Contributed by Tal Einat and Saimadhav Heblikar in :issue:`17535`.)
522
Terry Jan Reedyfdcb5ae2018-09-25 12:45:27 -0400523Output over N lines (50 by default) is squeezed down to a button.
524N can be changed in the PyShell section of the General page of the
525Settings dialog. Fewer, but possibly extra long, lines can be squeezed by
526right clicking on the output. Squeezed output can be expanded in place
527by double-clicking the button or into the clipboard or a separate window
528by right-clicking the button. (Contributed by Tal Einat in :issue:`1529353`.)
529
530The changes above have been backported to 3.7 maintenance releases.
531
532
HongWeipengf1944792018-11-07 18:09:32 +0800533json.tool
534---------
535
536Add option ``--json-lines`` to parse every input line as separate JSON object.
537(Contributed by Weipeng Hong in :issue:`31553`.)
538
Pablo Galindobc098512019-02-07 07:04:02 +0000539
540math
541----
542
Raymond Hettinger3ff59622019-02-16 11:00:42 -0800543Added new function :func:`math.dist` for computing Euclidean distance
544between two points. (Contributed by Raymond Hettinger in :issue:`33089`.)
545
546Expanded the :func:`math.hypot` function to handle multiple dimensions.
547Formerly, it only supported the 2-D case.
548(Contributed by Raymond Hettinger in :issue:`33089`.)
549
Pablo Galindobc098512019-02-07 07:04:02 +0000550Added new function, :func:`math.prod`, as analogous function to :func:`sum`
551that returns the product of a 'start' value (default: 1) times an iterable of
Raymond Hettinger3ff59622019-02-16 11:00:42 -0800552numbers. (Contributed by Pablo Galindo in :issue:`35606`)
Pablo Galindobc098512019-02-07 07:04:02 +0000553
Mark Dickinson73934b92019-05-18 12:29:50 +0100554Added new function :func:`math.isqrt` for computing integer square roots.
555(Contributed by Mark Dickinson in :issue:`36887`.)
556
Mark Dickinsona0adffb2019-06-01 12:21:53 +0100557The function :func:`math.factorial` no longer accepts arguments that are not
558int-like. (Contributed by Pablo Galindo in :issue:`33083`.)
559
Zackery Spytz02db6962019-05-27 10:48:17 -0600560
561mmap
562----
563
564The :class:`mmap.mmap` class now has an :meth:`~mmap.mmap.madvise` method to
565access the ``madvise()`` system call.
566(Contributed by Zackery Spytz in :issue:`32941`.)
567
568
Victor Stinner17a55882019-05-28 16:02:50 +0200569multiprocessing
570---------------
571
572Added new :mod:`multiprocessing.shared_memory` module.
573(Contributed Davin Potts in :issue:`35813`.)
574
575On macOS, the *spawn* start method is now used by default.
576(Contributed by Victor Stinner in :issue:`33725`.)
577
578
Steve Dower2438cdf2019-03-29 16:37:16 -0700579os
580--
581
582Added new function :func:`~os.add_dll_directory` on Windows for providing
583additional search paths for native dependencies when importing extension
584modules or loading DLLs using :mod:`ctypes`.
585
Zackery Spytz43fdbd22019-05-29 13:57:07 -0600586A new :func:`os.memfd_create` function was added to wrap the
587``memfd_create()`` syscall.
588(Contributed by Zackery Spytz and Christian Heimes in :issue:`26836`.)
589
Pablo Galindobc098512019-02-07 07:04:02 +0000590
Serhiy Storchaka0185f342018-09-18 11:28:51 +0300591os.path
592-------
593
594:mod:`os.path` functions that return a boolean result like
595:func:`~os.path.exists`, :func:`~os.path.lexists`, :func:`~os.path.isdir`,
596:func:`~os.path.isfile`, :func:`~os.path.islink`, and :func:`~os.path.ismount`
597now return ``False`` instead of raising :exc:`ValueError` or its subclasses
598:exc:`UnicodeEncodeError` and :exc:`UnicodeDecodeError` for paths that contain
599characters or bytes unrepresentable at the OS level.
600(Contributed by Serhiy Storchaka in :issue:`33721`.)
601
Steve Dower8ef864d2019-03-12 15:15:26 -0700602:func:`~os.path.expanduser` on Windows now prefers the :envvar:`USERPROFILE`
603environment variable and does not use :envvar:`HOME`, which is not normally set
604for regular user accounts.
605
Serhiy Storchakab232df92018-10-30 13:22:42 +0200606
607ncurses
608-------
609
610Added a new variable holding structured version information for the
611underlying ncurses library: :data:`~curses.ncurses_version`.
612(Contributed by Serhiy Storchaka in :issue:`31680`.)
613
614
Serhiy Storchaka0185f342018-09-18 11:28:51 +0300615pathlib
616-------
617
618:mod:`pathlib.Path` methods that return a boolean result like
619:meth:`~pathlib.Path.exists()`, :meth:`~pathlib.Path.is_dir()`,
620:meth:`~pathlib.Path.is_file()`, :meth:`~pathlib.Path.is_mount()`,
621:meth:`~pathlib.Path.is_symlink()`, :meth:`~pathlib.Path.is_block_device()`,
622:meth:`~pathlib.Path.is_char_device()`, :meth:`~pathlib.Path.is_fifo()`,
623:meth:`~pathlib.Path.is_socket()` now return ``False`` instead of raising
624:exc:`ValueError` or its subclass :exc:`UnicodeEncodeError` for paths that
625contain characters unrepresentable at the OS level.
626(Contributed by Serhiy Storchaka in :issue:`33721`.)
627
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -0400628Added :meth:`pathlib.Path.link_to()` which creates a hard link pointing
629to a path.
630(Contributed by Joannah Nanjekye in :issue:`26978`)
631
jab9e00d9e2018-12-28 13:03:40 -0500632
Pierre Glaserec6c1bd2019-07-01 15:51:57 +0200633pickle
634------
635
636Reduction methods can now include a 6th item in the tuple they return. This
637item should specify a custom state-setting method that's called instead of the
638regular ``__setstate__`` method.
639(Contributed by Pierre Glaser and Olivier Grisel in :issue:`35900`)
640
641:mod:`pickle` extensions subclassing the C-optimized :class:`~pickle.Pickler`
642can now override the pickling logic of functions and classes by defining the
643special :meth:`~pickle.Pickler.reducer_override` method.
644(Contributed by Pierre Glaser and Olivier Grisel in :issue:`35900`)
645
646
Jon Janzenc981ad12019-05-15 22:14:38 +0200647plistlib
648--------
649
650Added new :class:`plistlib.UID` and enabled support for reading and writing
651NSKeyedArchiver-encoded binary plists.
652(Contributed by Jon Janzen in :issue:`26707`.)
653
654
Joannah Nanjekye2e33ecd2019-05-28 13:29:04 -0300655py_compile
656----------
657
658:func:`py_compile.compile` now supports silent mode.
659(Contributed by Joannah Nanjekye in :issue:`22640`.)
660
661
Giampaolo Rodolaeb7e29f2019-04-09 00:34:02 +0200662socket
663------
664
665Added :meth:`~socket.create_server()` and :meth:`~socket.has_dualstack_ipv6()`
666convenience functions to automate the necessary tasks usually involved when
667creating a server socket, including accepting both IPv4 and IPv6 connections
668on the same socket. (Contributed by Giampaolo Rodola in :issue:`17561`.)
669
Zackery Spytz8f96c9f2019-05-29 15:02:37 -0600670The :func:`socket.if_nameindex()`, :func:`socket.if_nametoindex()`, and
671:func:`socket.if_indextoname()` functions have been implemented on Windows.
672(Contributed by Zackery Spytz in :issue:`37007`.)
673
Bo Baylesca804952019-05-29 03:06:12 -0500674shlex
675----------
676
677The new :func:`shlex.join` function acts as the inverse of :func:`shlex.split`.
678(Contributed by Bo Bayles in :issue:`32102`.)
Giampaolo Rodolaeb7e29f2019-04-09 00:34:02 +0200679
jab9e00d9e2018-12-28 13:03:40 -0500680shutil
681------
682
683:func:`shutil.copytree` now accepts a new ``dirs_exist_ok`` keyword argument.
684(Contributed by Josh Bronson in :issue:`20849`.)
685
CAM Gerlach89a89442019-04-06 23:47:49 -0500686:func:`shutil.make_archive` now defaults to the modern pax (POSIX.1-2001)
687format for new archives to improve portability and standards conformance,
688inherited from the corresponding change to the :mod:`tarfile` module.
689(Contributed by C.A.M. Gerlach in :issue:`30661`.)
690
jab9e00d9e2018-12-28 13:03:40 -0500691
Christian Heimes9fb051f2018-09-23 08:32:31 +0200692ssl
693---
694
695Added :attr:`SSLContext.post_handshake_auth` to enable and
696:meth:`ssl.SSLSocket.verify_client_post_handshake` to initiate TLS 1.3
697post-handshake authentication.
698(Contributed by Christian Heimes in :issue:`34670`.)
699
Raymond Hettinger47d99872019-02-21 15:06:29 -0800700
701statistics
702----------
703
704Added :func:`statistics.fmean` as a faster, floating point variant of
705:func:`statistics.mean()`. (Contributed by Raymond Hettinger and
706Steven D'Aprano in :issue:`35904`.)
707
Raymond Hettinger6463ba32019-04-07 09:20:03 -0700708Added :func:`statistics.geometric_mean()`
709(Contributed by Raymond Hettinger in :issue:`27181`.)
710
Raymond Hettingerfc06a192019-03-12 00:43:27 -0700711Added :func:`statistics.multimode` that returns a list of the most
712common values. (Contributed by Raymond Hettinger in :issue:`35892`.)
713
Raymond Hettinger9013ccf2019-04-23 00:06:35 -0700714Added :func:`statistics.quantiles` that divides data or a distribution
715in to equiprobable intervals (e.g. quartiles, deciles, or percentiles).
716(Contributed by Raymond Hettinger in :issue:`36546`.)
717
Raymond Hettinger11c79532019-02-23 14:44:07 -0800718Added :class:`statistics.NormalDist`, a tool for creating
719and manipulating normal distributions of a random variable.
720(Contributed by Raymond Hettinger in :issue:`36018`.)
721
722::
723
724 >>> temperature_feb = NormalDist.from_samples([4, 12, -3, 2, 7, 14])
Raymond Hettinger671d7822019-05-01 17:49:12 -0700725 >>> temperature_feb.mean
726 6.0
727 >>> temperature_feb.stdev
728 6.356099432828281
Raymond Hettinger11c79532019-02-23 14:44:07 -0800729
730 >>> temperature_feb.cdf(3) # Chance of being under 3 degrees
731 0.3184678262814532
732 >>> # Relative chance of being 7 degrees versus 10 degrees
733 >>> temperature_feb.pdf(7) / temperature_feb.pdf(10)
734 1.2039930378537762
735
Raymond Hettinger671d7822019-05-01 17:49:12 -0700736 >>> el_niño = NormalDist(4, 2.5)
737 >>> temperature_feb += el_niño # Add in a climate effect
Raymond Hettinger11c79532019-02-23 14:44:07 -0800738 >>> temperature_feb
739 NormalDist(mu=10.0, sigma=6.830080526611674)
740
741 >>> temperature_feb * (9/5) + 32 # Convert to Fahrenheit
742 NormalDist(mu=50.0, sigma=12.294144947901014)
743 >>> temperature_feb.samples(3) # Generate random samples
744 [7.672102882379219, 12.000027119750287, 4.647488369766392]
745
Raymond Hettinger47d99872019-02-21 15:06:29 -0800746
Victor Stinneref9d9b62019-05-22 11:28:22 +0200747sys
748---
749
750Add new :func:`sys.unraisablehook` function which can be overridden to control
751how "unraisable exceptions" are handled. It is called when an exception has
752occurred but there is no way for Python to handle it. For example, when a
753destructor raises an exception or during garbage collection
754(:func:`gc.collect`).
Victor Stinner01ae8972019-06-03 16:28:01 +0200755(Contributed by Victor Stinner in :issue:`36829`.)
Victor Stinneref9d9b62019-05-22 11:28:22 +0200756
757
CAM Gerlache680c3d2019-03-21 09:44:51 -0500758tarfile
759-------
760
761The :mod:`tarfile` module now defaults to the modern pax (POSIX.1-2001)
762format for new archives, instead of the previous GNU-specific one.
763This improves cross-platform portability with a consistent encoding (UTF-8)
764in a standardized and extensible format, and offers several other benefits.
765(Contributed by C.A.M. Gerlach in :issue:`36268`.)
766
767
Victor Stinnercd590a72019-05-28 00:39:52 +0200768threading
769---------
770
Jake Tesler84846b02019-07-30 14:41:46 -0700771* Add a new :func:`threading.excepthook` function which handles uncaught
772 :meth:`threading.Thread.run` exception. It can be overridden to control how
773 uncaught :meth:`threading.Thread.run` exceptions are handled.
774 (Contributed by Victor Stinner in :issue:`1230540`.)
775
776* Add a new
777 :func:`threading.get_native_id` function and a :data:`~threading.Thread.native_id`
778 attribute to the :class:`threading.Thread` class. These return the native
779 integral Thread ID of the current thread assigned by the kernel.
780 This feature is only available on certain platforms, see
781 :func:`get_native_id <threading.get_native_id>` for more information.
782 (Contributed by Jake Tesler in :issue:`36084`.)
Victor Stinnercd590a72019-05-28 00:39:52 +0200783
784
Tal Einatdfba1f62018-10-24 10:20:05 +0300785tokenize
786--------
787
788The :mod:`tokenize` module now implicitly emits a ``NEWLINE`` token when
789provided with input that does not have a trailing new line. This behavior
790now matches what the C tokenizer does internally.
791(Contributed by Ammar Askar in :issue:`33899`.)
792
Juliette Monselaf5658a2018-10-08 18:29:24 +0200793tkinter
794-------
795
796Added methods :meth:`~tkinter.Spinbox.selection_from`,
797:meth:`~tkinter.Spinbox.selection_present`,
798:meth:`~tkinter.Spinbox.selection_range` and
799:meth:`~tkinter.Spinbox.selection_to`
800in the :class:`tkinter.Spinbox` class.
801(Contributed by Juliette Monsel in :issue:`34829`.)
802
Juliette Monselbf034712018-10-12 18:44:10 +0200803Added method :meth:`~tkinter.Canvas.moveto`
804in the :class:`tkinter.Canvas` class.
805(Contributed by Juliette Monsel in :issue:`23831`.)
806
Zackery Spytz50866e92019-04-05 04:17:13 -0600807The :class:`tkinter.PhotoImage` class now has
808:meth:`~tkinter.PhotoImage.transparency_get` and
809:meth:`~tkinter.PhotoImage.transparency_set` methods. (Contributed by
810Zackery Spytz in :issue:`25451`.)
811
Joannah Nanjekye572168a2019-01-10 19:56:38 +0300812time
813----
814
815Added new clock :data:`~time.CLOCK_UPTIME_RAW` for macOS 10.12.
816(Contributed by Joannah Nanjekye in :issue:`35702`.)
817
Guido van Rossum9b33ce42019-06-11 13:42:35 -0700818
819typing
820------
821
822The :mod:`typing` module incorporates several new features:
823
824* Protocol definitions. See :pep:`544`, :class:`typing.Protocol` and
825 :func:`typing.runtime_checkable`. Simple ABCs like
826 :class:`typing.SupportsInt` are now ``Protocol`` subclasses.
827
828* A dictionary type with per-key types. See :pep:`589` and
829 :class:`typing.TypedDict`.
830
831* Literal types. See :pep:`586` and :class:`typing.Literal`.
832
833* "Final" variables, functions, methods and classes. See :pep:`591`,
834 :class:`typing.Final` and :func:`typing.final`.
835
836* New protocol class :class:`typing.SupportsIndex`.
837
838* New functions :func:`typing.get_origin` and :func:`typing.get_args`.
839
840
Max Bélanger2810dd72018-11-04 15:58:24 -0800841unicodedata
842-----------
843
Benjamin Peterson3aca40d2019-05-08 20:59:35 -0700844* The :mod:`unicodedata` module has been upgraded to use the `Unicode 12.1.0
845 <http://blog.unicode.org/2019/05/unicode-12-1-en.html>`_ release.
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700846
Max Bélanger2810dd72018-11-04 15:58:24 -0800847* New function :func:`~unicodedata.is_normalized` can be used to verify a string
848 is in a specific normal form. (Contributed by Max Belanger and David Euresti in
849 :issue:`32285`).
850
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700851
Lisa Roach0f221d02018-11-08 18:34:33 -0800852unittest
853--------
854
Victor Stinner01ae8972019-06-03 16:28:01 +0200855* Added :class:`AsyncMock` to support an asynchronous version of :class:`Mock`.
Lisa Roach77b3b772019-05-20 09:19:53 -0700856 Appropriate new assert functions for testing have been added as well.
857 (Contributed by Lisa Roach in :issue:`26467`).
858
Lisa Roach0f221d02018-11-08 18:34:33 -0800859* Added :func:`~unittest.addModuleCleanup()` and
860 :meth:`~unittest.TestCase.addClassCleanup()` to unittest to support
861 cleanups for :func:`~unittest.setUpModule()` and
862 :meth:`~unittest.TestCase.setUpClass()`.
863 (Contributed by Lisa Roach in :issue:`24412`.)
864
Petter Strandmark001d63c2019-06-04 21:34:49 +0200865* Several mock assert functions now also print a list of actual calls upon
866 failure. (Contributed by Petter Strandmark in :issue:`35047`.)
867
Brett Cannond64ee1a2018-09-21 15:27:26 -0700868venv
869----
870
871* :mod:`venv` now includes an ``Activate.ps1`` script on all platforms for
872 activating virtual environments under PowerShell Core 6.1.
873 (Contributed by Brett Cannon in :issue:`32718`.)
874
Mark Dickinson7abb6c02019-04-26 15:56:15 +0900875weakref
876-------
877
878* The proxy objects returned by :func:`weakref.proxy` now support the matrix
879 multiplication operators ``@`` and ``@=`` in addition to the other
880 numeric operators. (Contributed by Mark Dickinson in :issue:`36669`.)
881
Christian Heimes17b1d5d2018-09-23 09:50:25 +0200882xml
883---
884
885* As mitigation against DTD and external entity retrieval, the
Andrés Delfinoca682612018-11-07 14:29:14 -0300886 :mod:`xml.dom.minidom` and :mod:`xml.sax` modules no longer process
Christian Heimes17b1d5d2018-09-23 09:50:25 +0200887 external entities by default.
888 (Contributed by Christian Heimes in :issue:`17239`.)
889
Stefan Behnel47541682019-05-03 20:58:16 +0200890* The ``.find*()`` methods in the :mod:`xml.etree.ElementTree` module
891 support wildcard searches like ``{*}tag`` which ignores the namespace
892 and ``{namespace}*`` which returns all tags in the given namespace.
893 (Contributed by Stefan Behnel in :issue:`28238`.)
894
Stefan Behnele1d5dd62019-05-01 22:34:13 +0200895* The :mod:`xml.etree.ElementTree` module provides a new function
896 :func:`–xml.etree.ElementTree.canonicalize()` that implements C14N 2.0.
897 (Contributed by Stefan Behnel in :issue:`13611`.)
898
Stefan Behnele9a465f2019-05-10 10:25:13 +0200899* The target object of :class:`xml.etree.ElementTree.XMLParser` can
900 receive namespace declaration events through the new callback methods
901 ``start_ns()`` and ``end_ns()``. Additionally, the
902 :class:`xml.etree.ElementTree.TreeBuilder` target can be configured
903 to process events about comments and processing instructions to include
904 them in the generated tree.
905 (Contributed by Stefan Behnel in :issue:`36676` and :issue:`36673`.)
Christian Heimes17b1d5d2018-09-23 09:50:25 +0200906
Ned Deily07a18922018-01-31 18:12:38 -0500907Optimizations
908=============
909
Victor Stinner9daecf32019-01-16 00:02:35 +0100910* The :mod:`subprocess` module can now use the :func:`os.posix_spawn` function
911 in some cases for better performance. Currently, it is only used on macOS
912 and Linux (using glibc 2.24 or newer) if all these conditions are met:
913
914 * *close_fds* is false;
Victor Stinnerf6243ac2019-01-23 19:00:39 +0100915 * *preexec_fn*, *pass_fds*, *cwd* and *start_new_session* parameters
916 are not set;
Victor Stinner8c349562019-01-16 23:38:06 +0100917 * the *executable* path contains a directory.
Victor Stinner9daecf32019-01-16 00:02:35 +0100918
Victor Stinner01ae8972019-06-03 16:28:01 +0200919 (Contributed by Joannah Nanjekye and Victor Stinner in :issue:`35537`.)
920
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +0200921* :func:`shutil.copyfile`, :func:`shutil.copy`, :func:`shutil.copy2`,
922 :func:`shutil.copytree` and :func:`shutil.move` use platform-specific
Giampaolo Rodola413d9552019-05-30 14:05:41 +0800923 "fast-copy" syscalls on Linux and macOS in order to copy the file
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -0700924 more efficiently.
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +0200925 "fast-copy" means that the copying operation occurs within the kernel,
926 avoiding the use of userspace buffers in Python as in
927 "``outfd.write(infd.read())``".
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -0700928 On Windows :func:`shutil.copyfile` uses a bigger default buffer size (1 MiB
929 instead of 16 KiB) and a :func:`memoryview`-based variant of
930 :func:`shutil.copyfileobj` is used.
931 The speedup for copying a 512 MiB file within the same partition is about
932 +26% on Linux, +50% on macOS and +40% on Windows. Also, much less CPU cycles
933 are consumed.
934 See :ref:`shutil-platform-dependent-efficient-copy-operations` section.
Mariatta16501b72018-12-06 21:59:42 -0800935 (Contributed by Giampaolo Rodola' in :issue:`33671`.)
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +0200936
Giampaolo Rodola19c46a42018-11-12 06:18:15 -0800937* :func:`shutil.copytree` uses :func:`os.scandir` function and all copy
938 functions depending from it use cached :func:`os.stat` values. The speedup
939 for copying a directory with 8000 files is around +9% on Linux, +20% on
940 Windows and +30% on a Windows SMB share. Also the number of :func:`os.stat`
941 syscalls is reduced by 38% making :func:`shutil.copytree` especially faster
942 on network filesystems. (Contributed by Giampaolo Rodola' in :issue:`33695`.)
943
Łukasz Langac51d8c92018-04-03 23:06:53 -0700944* The default protocol in the :mod:`pickle` module is now Protocol 4,
945 first introduced in Python 3.4. It offers better performance and smaller
946 size compared to Protocol 3 available since Python 3.0.
Ned Deily07a18922018-01-31 18:12:38 -0500947
INADA Naokid5c875b2018-07-11 17:42:49 +0900948* Removed one ``Py_ssize_t`` member from ``PyGC_Head``. All GC tracked
949 objects (e.g. tuple, list, dict) size is reduced 4 or 8 bytes.
950 (Contributed by Inada Naoki in :issue:`33597`)
951
Tal Einat54752532018-09-10 16:11:04 +0300952* :class:`uuid.UUID` now uses ``__slots__`` to reduce its memory footprint.
Tal Einat54752532018-09-10 16:11:04 +0300953
Raymond Hettinger63fa1cf2019-02-16 12:02:22 -0800954* Improved performance of :func:`operator.itemgetter` by 33%. Optimized
955 argument handling and added a fast path for the common case of a single
956 non-negative integer index into a tuple (which is the typical use case in
957 the standard library). (Contributed by Raymond Hettinger in
958 :issue:`35664`.)
959
960* Sped-up field lookups in :func:`collections.namedtuple`. They are now more
961 than two times faster, making them the fastest form of instance variable
962 lookup in Python. (Contributed by Raymond Hettinger, Pablo Galindo, and
Joe Jevnikf36f8922019-02-21 16:00:40 -0500963 Joe Jevnik, Serhiy Storchaka in :issue:`32492`.)
Raymond Hettinger63fa1cf2019-02-16 12:02:22 -0800964
Pablo Galindoc61e2292018-10-28 22:03:18 +0000965* The :class:`list` constructor does not overallocate the internal item buffer
966 if the input iterable has a known length (the input implements ``__len__``).
Raymond Hettingere1823182019-02-16 12:47:48 -0800967 This makes the created list 12% smaller on average. (Contributed by
968 Raymond Hettinger and Pablo Galindo in :issue:`33234`.)
Pablo Galindoc61e2292018-10-28 22:03:18 +0000969
Stefan Behneld8b9e1f2019-02-20 18:29:24 +0100970* Doubled the speed of class variable writes. When a non-dunder attribute
971 was updated, there was an unnecessary call to update slots.
972 (Contributed by Stefan Behnel, Pablo Galindo Salgado, Raymond Hettinger,
973 Neil Schemenauer, and Serhiy Storchaka in :issue:`36012`.)
974
Serhiy Storchaka31913912019-03-14 10:32:22 +0200975* Reduced an overhead of converting arguments passed to many builtin functions
976 and methods. This sped up calling some simple builtin functions and
977 methods up to 20--50%. (Contributed by Serhiy Storchaka in :issue:`23867`,
978 :issue:`35582` and :issue:`36127`.)
979
Inada Naoki91234a12019-06-03 21:30:58 +0900980* ``LOAD_GLOBAL`` instruction now uses new "per opcode cache" mechanism.
981 It is about 40% faster now. (Contributed by Yury Selivanov and Inada Naoki in
982 :issue:`26219`.)
983
Serhiy Storchakaceeef102018-06-15 11:09:43 +0300984
Ned Deily07a18922018-01-31 18:12:38 -0500985Build and C API Changes
986=======================
987
Victor Stinner7efc5262019-06-15 03:24:41 +0200988* Default :data:`sys.abiflags` became an empty string: the ``m`` flag for
989 pymalloc became useless (builds with and without pymalloc are ABI compatible)
990 and so has been removed. (Contributed by Victor Stinner in :issue:`36707`.)
991
992 Example of changes:
993
994 * Only ``python3.8`` program is installed, ``python3.8m`` program is gone.
995 * Only ``python3.8-config`` script is installed, ``python3.8m-config`` script
996 is gone.
997 * The ``m`` flag has been removed from the suffix of dynamic library
998 filenames: extension modules in the standard library as well as those
999 produced and installed by third-party packages, like those downloaded from
1000 PyPI. On Linux, for example, the Python 3.7 suffix
1001 ``.cpython-37m-x86_64-linux-gnu.so`` became
1002 ``.cpython-38-x86_64-linux-gnu.so`` in Python 3.8.
1003
Victor Stinnerbd5798f2019-06-14 19:43:43 +02001004* The header files have been reorganized to better separate the different kinds
1005 of APIs:
1006
1007 * ``Include/*.h`` should be the portable public stable C API.
1008 * ``Include/cpython/*.h`` should be the unstable C API specific to CPython;
Victor Stinneraf41c562019-06-20 01:44:58 +02001009 public API, with some private API prefixed by ``_Py`` or ``_PY``.
Victor Stinnerbd5798f2019-06-14 19:43:43 +02001010 * ``Include/internal/*.h`` is the private internal C API very specific to
1011 CPython. This API comes with no backward compatibility warranty and should
1012 not be used outside CPython. It is only exposed for very specific needs
1013 like debuggers and profiles which has to access to CPython internals
1014 without calling functions. This API is now installed by ``make install``.
1015
1016 (Contributed by Victor Stinner in :issue:`35134` and :issue:`35081`,
1017 work initiated by Eric Snow in Python 3.7)
1018
1019* Some macros have been converted to static inline functions: parameter types
1020 and return type are well defined, they don't have issues specific to macros,
1021 variables have a local scopes. Examples:
1022
1023 * :c:func:`Py_INCREF`, :c:func:`Py_DECREF`
1024 * :c:func:`Py_XINCREF`, :c:func:`Py_XDECREF`
1025 * :c:func:`PyObject_INIT`, :c:func:`PyObject_INIT_VAR`
1026 * Private functions: :c:func:`_PyObject_GC_TRACK`,
1027 :c:func:`_PyObject_GC_UNTRACK`, :c:func:`_Py_Dealloc`
1028
1029 (Contributed by Victor Stinner in :issue:`35059`.)
1030
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001031* The :c:func:`PyByteArray_Init` and :c:func:`PyByteArray_Fini` functions have
1032 been removed. They did nothing since Python 2.7.4 and Python 3.2.0, were
1033 excluded from the limited API (stable ABI), and were not documented.
Victor Stinnerc68e3fb2019-06-20 22:41:25 +02001034 (Contributed by Victor Stinner in :issue:`35713`.)
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +01001035
Serhiy Storchakaceeef102018-06-15 11:09:43 +03001036* The result of :c:func:`PyExceptionClass_Name` is now of type
1037 ``const char *`` rather of ``char *``.
1038 (Contributed by Serhiy Storchaka in :issue:`33818`.)
Ned Deily07a18922018-01-31 18:12:38 -05001039
Antoine Pitrou961d54c2018-07-16 19:03:03 +02001040* The duality of ``Modules/Setup.dist`` and ``Modules/Setup`` has been
1041 removed. Previously, when updating the CPython source tree, one had
1042 to manually copy ``Modules/Setup.dist`` (inside the source tree) to
1043 ``Modules/Setup`` (inside the build tree) in order to reflect any changes
1044 upstream. This was of a small benefit to packagers at the expense of
1045 a frequent annoyance to developers following CPython development, as
1046 forgetting to copy the file could produce build failures.
1047
1048 Now the build system always reads from ``Modules/Setup`` inside the source
1049 tree. People who want to customize that file are encouraged to maintain
1050 their changes in a git fork of CPython or as patch files, as they would do
1051 for any other change to the source tree.
1052
1053 (Contributed by Antoine Pitrou in :issue:`32430`.)
1054
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001055* Functions that convert Python number to C integer like
1056 :c:func:`PyLong_AsLong` and argument parsing functions like
1057 :c:func:`PyArg_ParseTuple` with integer converting format units like ``'i'``
1058 will now use the :meth:`~object.__index__` special method instead of
1059 :meth:`~object.__int__`, if available. The deprecation warning will be
1060 emitted for objects with the ``__int__()`` method but without the
1061 ``__index__()`` method (like :class:`~decimal.Decimal` and
1062 :class:`~fractions.Fraction`). :c:func:`PyNumber_Check` will now return
1063 ``1`` for objects implementing ``__index__()``.
Serhiy Storchakabdbad712019-06-02 00:05:48 +03001064 :c:func:`PyNumber_Long`, :c:func:`PyNumber_Float` and
1065 :c:func:`PyFloat_AsDouble` also now use the ``__index__()`` method if
1066 available.
1067 (Contributed by Serhiy Storchaka in :issue:`36048` and :issue:`20092`.)
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001068
Eddie Elizondo364f0b02019-03-27 07:52:18 -04001069* Heap-allocated type objects will now increase their reference count
1070 in :c:func:`PyObject_Init` (and its parallel macro ``PyObject_INIT``)
1071 instead of in :c:func:`PyType_GenericAlloc`. Types that modify instance
1072 allocation or deallocation may need to be adjusted.
1073 (Contributed by Eddie Elizondo in :issue:`35810`.)
1074
Pablo Galindo4a2edc32019-07-01 11:35:05 +01001075* The new function :c:func:`PyCode_NewWithPosOnlyArgs` allows to create
1076 code objects like :c:func:`PyCode_New`, but with an extra *posonlyargcount*
1077 parameter for indicating the number of positional-only arguments.
1078 (Contributed by Pablo Galindo in :issue:`37221`.)
1079
Ned Deily07a18922018-01-31 18:12:38 -05001080
1081Deprecated
1082==========
1083
Victor Stinner1da44622019-07-05 10:44:12 +02001084* The distutils ``bdist_wininst`` command is now deprecated, use
1085 ``bdist_wheel`` (wheel packages) instead.
1086 (Contributed by Victor Stinner in :issue:`37481`.)
1087
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001088* Deprecated methods ``getchildren()`` and ``getiterator()`` in
1089 the :mod:`~xml.etree.ElementTree` module emit now a
1090 :exc:`DeprecationWarning` instead of :exc:`PendingDeprecationWarning`.
1091 They will be removed in Python 3.9.
1092 (Contributed by Serhiy Storchaka in :issue:`29209`.)
Ned Deily07a18922018-01-31 18:12:38 -05001093
Elvis Pranskevichus22d25082018-07-30 11:42:43 +01001094* Passing an object that is not an instance of
1095 :class:`concurrent.futures.ThreadPoolExecutor` to
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001096 :meth:`asyncio.loop.set_default_executor()` is
Elvis Pranskevichus22d25082018-07-30 11:42:43 +01001097 deprecated and will be prohibited in Python 3.9.
1098 (Contributed by Elvis Pranskevichus in :issue:`34075`.)
1099
Berker Peksagef8861c2018-08-21 17:58:49 +03001100* The :meth:`__getitem__` methods of :class:`xml.dom.pulldom.DOMEventStream`,
1101 :class:`wsgiref.util.FileWrapper` and :class:`fileinput.FileInput` have been
1102 deprecated.
1103
1104 Implementations of these methods have been ignoring their *index* parameter,
1105 and returning the next item instead.
1106
1107 (Contributed by Berker Peksag in :issue:`9372`.)
1108
Raymond Hettingerf7b57df2019-03-18 09:53:56 -07001109* The :class:`typing.NamedTuple` class has deprecated the ``_field_types``
1110 attribute in favor of the ``__annotations__`` attribute which has the same
1111 information. (Contributed by Raymond Hettinger in :issue:`36320`.)
1112
Serhiy Storchaka3f228112018-09-27 17:42:37 +03001113* :mod:`ast` classes ``Num``, ``Str``, ``Bytes``, ``NameConstant`` and
1114 ``Ellipsis`` are considered deprecated and will be removed in future Python
1115 versions. :class:`~ast.Constant` should be used instead.
1116 (Contributed by Serhiy Storchaka in :issue:`32892`.)
1117
Serhiy Storchakafec35c92018-10-27 08:00:41 +03001118* The following functions and methods are deprecated in the :mod:`gettext`
1119 module: :func:`~gettext.lgettext`, :func:`~gettext.ldgettext`,
1120 :func:`~gettext.lngettext` and :func:`~gettext.ldngettext`.
1121 They return encoded bytes, and it's possible that you will get unexpected
1122 Unicode-related exceptions if there are encoding problems with the
1123 translated strings. It's much better to use alternatives which return
1124 Unicode strings in Python 3. These functions have been broken for a long time.
1125
1126 Function :func:`~gettext.bind_textdomain_codeset`, methods
1127 :meth:`~gettext.NullTranslations.output_charset` and
1128 :meth:`~gettext.NullTranslations.set_output_charset`, and the *codeset*
1129 parameter of functions :func:`~gettext.translation` and
1130 :func:`~gettext.install` are also deprecated, since they are only used for
1131 for the ``l*gettext()`` functions.
1132
1133 (Contributed by Serhiy Storchaka in :issue:`33710`.)
1134
Dong-hee Na89669ff2019-01-17 21:14:45 +09001135* The :meth:`~threading.Thread.isAlive()` method of :class:`threading.Thread` has been deprecated.
1136 (Contributed by Dong-hee Na in :issue:`35283`.)
Ned Deily07a18922018-01-31 18:12:38 -05001137
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001138* Many builtin and extension functions that take integer arguments will
1139 now emit a deprecation warning for :class:`~decimal.Decimal`\ s,
1140 :class:`~fractions.Fraction`\ s and any other objects that can be converted
1141 to integers only with a loss (e.g. that have the :meth:`~object.__int__`
1142 method but do not have the :meth:`~object.__index__` method). In future
1143 version they will be errors.
1144 (Contributed by Serhiy Storchaka in :issue:`36048`.)
1145
Serhiy Storchaka42a139e2019-04-01 09:16:35 +03001146* Deprecated passing the following arguments as keyword arguments:
1147
1148 - *func* in :func:`functools.partialmethod`, :func:`weakref.finalize`,
1149 :meth:`profile.Profile.runcall`, :meth:`cProfile.Profile.runcall`,
1150 :meth:`bdb.Bdb.runcall`, :meth:`trace.Trace.runfunc` and
1151 :func:`curses.wrapper`.
Serhiy Storchaka2085bd02019-06-01 11:00:15 +03001152 - *function* in :meth:`unittest.TestCase.addCleanup`.
Serhiy Storchaka42a139e2019-04-01 09:16:35 +03001153 - *fn* in the :meth:`~concurrent.futures.Executor.submit` method of
1154 :class:`concurrent.futures.ThreadPoolExecutor` and
1155 :class:`concurrent.futures.ProcessPoolExecutor`.
1156 - *callback* in :meth:`contextlib.ExitStack.callback`,
1157 :meth:`contextlib.AsyncExitStack.callback` and
1158 :meth:`contextlib.AsyncExitStack.push_async_callback`.
1159 - *c* and *typeid* in the :meth:`~multiprocessing.managers.Server.create`
1160 method of :class:`multiprocessing.managers.Server` and
1161 :class:`multiprocessing.managers.SharedMemoryServer`.
1162 - *obj* in :func:`weakref.finalize`.
1163
1164 In future releases of Python they will be :ref:`positional-only
1165 <positional-only_parameter>`.
1166 (Contributed by Serhiy Storchaka in :issue:`36492`.)
1167
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001168
Victor Stinner73104fa2018-11-29 09:58:20 +01001169API and Feature Removals
1170========================
1171
1172The following features and APIs have been removed from Python 3.8:
1173
Victor Stinnerd7538dd2018-12-14 13:37:26 +01001174* The :mod:`macpath` module, deprecated in Python 3.7, has been removed.
1175 (Contributed by Victor Stinner in :issue:`35471`.)
1176
Victor Stinner73104fa2018-11-29 09:58:20 +01001177* The function :func:`platform.popen` has been removed, it was deprecated since
1178 Python 3.3: use :func:`os.popen` instead.
Victor Stinner01ae8972019-06-03 16:28:01 +02001179 (Contributed by Victor Stinner in :issue:`35345`.)
Ned Deily07a18922018-01-31 18:12:38 -05001180
Matthias Bussonnierb6a09ae2019-05-13 12:23:07 -07001181* The function :func:`time.clock` has been removed, it was deprecated since Python
1182 3.3: use :func:`time.perf_counter` or :func:`time.process_time` instead, depending
1183 on your requirements, to have a well defined behavior.
Victor Stinner01ae8972019-06-03 16:28:01 +02001184 (Contributed by Matthias Bussonnier in :issue:`36895`.)
Matthias Bussonnierb6a09ae2019-05-13 12:23:07 -07001185
Brett Cannona8c34242018-04-20 14:15:40 -07001186* The ``pyvenv`` script has been removed in favor of ``python3.8 -m venv``
1187 to help eliminate confusion as to what Python interpreter the ``pyvenv``
1188 script is tied to. (Contributed by Brett Cannon in :issue:`25427`.)
Ned Deily07a18922018-01-31 18:12:38 -05001189
INADA Naoki698865d2018-06-19 17:28:50 +09001190* ``parse_qs``, ``parse_qsl``, and ``escape`` are removed from :mod:`cgi`
1191 module. They are deprecated from Python 3.2 or older.
1192
INADA Naoki461a1c42018-06-28 17:10:36 +09001193* ``filemode`` function is removed from :mod:`tarfile` module.
1194 It is not documented and deprecated since Python 3.3.
INADA Naoki698865d2018-06-19 17:28:50 +09001195
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001196* The :class:`~xml.etree.ElementTree.XMLParser` constructor no longer accepts
1197 the *html* argument. It never had effect and was deprecated in Python 3.4.
1198 All other parameters are now :ref:`keyword-only <keyword-only_parameter>`.
1199 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1200
1201* Removed the ``doctype()`` method of :class:`~xml.etree.ElementTree.XMLParser`.
1202 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1203
Inada Naoki6a16b182019-03-18 15:44:11 +09001204* "unicode_internal" codec is removed.
1205 (Contributed by Inada Naoki in :issue:`36297`.)
1206
Aviv Palivodae6576242019-05-09 21:05:45 +03001207* The ``Cache`` and ``Statement`` objects of the :mod:`sqlite3` module are not
1208 exposed to the user.
1209 (Contributed by Aviv Palivoda in :issue:`30262`.)
1210
Matthias Bussonnier1a3faf92019-05-20 13:44:11 -07001211* The ``bufsize`` keyword argument of :func:`fileinput.input` and
1212 :func:`fileinput.FileInput` which was ignored and deprecated since Python 3.6
1213 has been removed. :issue:`36952` (Contributed by Matthias Bussonnier)
1214
Matthias Bussonnier382034b2019-05-28 10:30:35 -07001215* The functions :func:`sys.set_coroutine_wrapper` and
1216 :func:`sys.get_coroutine_wrapper` deprecated in Python 3.7 have been removed;
1217 :issue:`36933` (Contributed by Matthias Bussonnier)
Matthias Bussonnier3880f262019-05-28 00:10:59 -07001218
Ned Deily07a18922018-01-31 18:12:38 -05001219
1220Porting to Python 3.8
1221=====================
1222
1223This section lists previously described changes and other bugfixes
1224that may require changes to your code.
1225
1226
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001227Changes in Python behavior
1228--------------------------
1229
1230* Yield expressions (both ``yield`` and ``yield from`` clauses) are now disallowed
1231 in comprehensions and generator expressions (aside from the iterable expression
Serhiy Storchaka2b57c432018-12-19 08:09:46 +02001232 in the leftmost :keyword:`!for` clause).
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001233 (Contributed by Serhiy Storchaka in :issue:`10544`.)
1234
Serhiy Storchaka3bcbedc2019-01-18 07:47:48 +02001235* The compiler now produces a :exc:`SyntaxWarning` when identity checks
1236 (``is`` and ``is not``) are used with certain types of literals
1237 (e.g. strings, ints). These can often work by accident in CPython,
1238 but are not guaranteed by the language spec. The warning advises users
1239 to use equality tests (``==`` and ``!=``) instead.
1240 (Contributed by Serhiy Storchaka in :issue:`34850`.)
1241
Serhiy Storchaka7a0630c2019-04-08 14:34:04 +03001242* The CPython interpreter can swallow exceptions in some circumstances.
1243 In Python 3.8 this happens in less cases. In particular, exceptions
1244 raised when getting the attribute from the type dictionary are no longer
1245 ignored. (Contributed by Serhiy Storchaka in :issue:`35459`.)
1246
Serhiy Storchaka96aeaec2019-05-06 22:29:40 +03001247* Removed ``__str__`` implementations from builtin types :class:`bool`,
1248 :class:`int`, :class:`float`, :class:`complex` and few classes from
1249 the standard library. They now inherit ``__str__()`` from :class:`object`.
1250 As result, defining the ``__repr__()`` method in the subclass of these
1251 classes will affect they string representation.
1252 (Contributed by Serhiy Storchaka in :issue:`36793`.)
1253
Michael Felt9d949f72019-04-12 16:15:32 +02001254* On AIX, :attr:`sys.platform` doesn't contain the major version anymore.
1255 It is always ``'aix'``, instead of ``'aix3'`` .. ``'aix7'``. Since
1256 older Python versions include the version number, it is recommended to
1257 always use the ``sys.platform.startswith('aix')``.
1258 (Contributed by M. Felt in :issue:`36588`.)
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001259
Joannah Nanjekyef781d202019-04-29 04:38:45 -04001260* :c:func:`PyEval_AcquireLock` and :c:func:`PyEval_AcquireThread` now
1261 terminate the current thread if called while the interpreter is
1262 finalizing, making them consistent with :c:func:`PyEval_RestoreThread`,
1263 :c:func:`Py_END_ALLOW_THREADS`, and :c:func:`PyGILState_Ensure`. If this
1264 behaviour is not desired, guard the call by checking :c:func:`_Py_IsFinalizing`
1265 or :c:func:`sys.is_finalizing`.
1266
Serhiy Storchaka97f1ca12018-02-01 18:49:21 +02001267Changes in the Python API
1268-------------------------
1269
Victor Stinner689830e2019-06-26 17:31:12 +02001270* The :func:`os.getcwdb` function now uses the UTF-8 encoding on Windows,
1271 rather than the ANSI code page: see :pep:`529` for the rationale. The
1272 function is no longer deprecated on Windows.
1273 (Contributed by Victor Stinner in :issue:`37412`.)
1274
Victor Stinnerd7befad2019-04-25 14:30:16 +02001275* :class:`subprocess.Popen` can now use :func:`os.posix_spawn` in some cases
1276 for better performance. On Windows Subsystem for Linux and QEMU User
1277 Emulation, Popen constructor using :func:`os.posix_spawn` no longer raise an
1278 exception on errors like missing program, but the child process fails with a
1279 non-zero :attr:`~Popen.returncode`.
Victor Stinner01ae8972019-06-03 16:28:01 +02001280 (Contributed by Joannah Nanjekye and Victor Stinner in :issue:`35537`.)
Victor Stinnerd7befad2019-04-25 14:30:16 +02001281
Victor Stinner74125a62019-04-15 18:23:20 +02001282* The :meth:`imap.IMAP4.logout` method no longer ignores silently arbitrary
1283 exceptions.
1284
Victor Stinner73104fa2018-11-29 09:58:20 +01001285* The function :func:`platform.popen` has been removed, it was deprecated since
1286 Python 3.3: use :func:`os.popen` instead.
Victor Stinner01ae8972019-06-03 16:28:01 +02001287 (Contributed by Victor Stinner in :issue:`35345`.)
Victor Stinner73104fa2018-11-29 09:58:20 +01001288
Raymond Hettingerfc06a192019-03-12 00:43:27 -07001289* The :func:`statistics.mode` function no longer raises an exception
1290 when given multimodal data. Instead, it returns the first mode
1291 encountered in the input data. (Contributed by Raymond Hettinger
1292 in :issue:`35892`.)
1293
Serhiy Storchaka97f1ca12018-02-01 18:49:21 +02001294* The :meth:`~tkinter.ttk.Treeview.selection` method of the
1295 :class:`tkinter.ttk.Treeview` class no longer takes arguments. Using it with
1296 arguments for changing the selection was deprecated in Python 3.6. Use
1297 specialized methods like :meth:`~tkinter.ttk.Treeview.selection_set` for
1298 changing the selection. (Contributed by Serhiy Storchaka in :issue:`31508`.)
Serhiy Storchaka6c85efa52018-02-05 22:47:31 +02001299
Diego Rojas06e1e682019-03-16 18:44:56 -05001300* The :meth:`writexml`, :meth:`toxml` and :meth:`toprettyxml` methods of the
1301 :mod:`xml.dom.minidom` module, and :mod:`xml.etree` now preserve the attribute
1302 order specified by the user.
1303 (Contributed by Diego Rojas and Raymond Hettinger in :issue:`34160`.)
1304
Serhiy Storchaka6c85efa52018-02-05 22:47:31 +02001305* A :mod:`dbm.dumb` database opened with flags ``'r'`` is now read-only.
1306 :func:`dbm.dumb.open` with flags ``'r'`` and ``'w'`` no longer creates
1307 a database if it does not exist.
1308 (Contributed by Serhiy Storchaka in :issue:`32749`.)
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001309
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001310* The ``doctype()`` method defined in a subclass of
1311 :class:`~xml.etree.ElementTree.XMLParser` will no longer be called and will
1312 cause emitting a :exc:`RuntimeWarning` instead of a :exc:`DeprecationWarning`.
1313 Define the :meth:`doctype() <xml.etree.ElementTree.TreeBuilder.doctype>`
1314 method on a target for handling an XML doctype declaration.
1315 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1316
Serhiy Storchakaf5e7b192018-05-20 08:48:12 +03001317* A :exc:`RuntimeError` is now raised when the custom metaclass doesn't
1318 provide the ``__classcell__`` entry in the namespace passed to
1319 ``type.__new__``. A :exc:`DeprecationWarning` was emitted in Python
1320 3.6--3.7. (Contributed by Serhiy Storchaka in :issue:`23722`.)
1321
Scott Sandersoncebe80b2018-06-07 05:46:42 -04001322* The :class:`cProfile.Profile` class can now be used as a context
1323 manager. (Contributed by Scott Sanderson in :issue:`29235`.)
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001324
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07001325* :func:`shutil.copyfile`, :func:`shutil.copy`, :func:`shutil.copy2`,
1326 :func:`shutil.copytree` and :func:`shutil.move` use platform-specific
1327 "fast-copy" syscalls (see
1328 :ref:`shutil-platform-dependent-efficient-copy-operations` section).
1329
1330* :func:`shutil.copyfile` default buffer size on Windows was changed from
1331 16 KiB to 1 MiB.
1332
INADA Naokid5c875b2018-07-11 17:42:49 +09001333* ``PyGC_Head`` struct is changed completely. All code touched the
1334 struct member should be rewritten. (See :issue:`33597`)
1335
Eric Snowbe3b2952019-02-23 11:35:52 -07001336* The ``PyInterpreterState`` struct has been moved into the "internal"
1337 header files (specifically Include/internal/pycore_pystate.h). An
1338 opaque ``PyInterpreterState`` is still available as part of the public
1339 API (and stable ABI). The docs indicate that none of the struct's
1340 fields are public, so we hope no one has been using them. However,
1341 if you do rely on one or more of those private fields and have no
1342 alternative then please open a BPO issue. We'll work on helping
1343 you adjust (possibly including adding accessor functions to the
1344 public API). (See :issue:`35886`.)
1345
Alex Grönholmcca4eec2018-08-09 00:06:47 +03001346* Asyncio tasks can now be named, either by passing the ``name`` keyword
1347 argument to :func:`asyncio.create_task` or
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001348 the :meth:`~asyncio.loop.create_task` event loop method, or by
Alex Grönholmcca4eec2018-08-09 00:06:47 +03001349 calling the :meth:`~asyncio.Task.set_name` method on the task object. The
1350 task name is visible in the ``repr()`` output of :class:`asyncio.Task` and
1351 can also be retrieved using the :meth:`~asyncio.Task.get_name` method.
1352
Berker Peksage7d4b2f2018-08-22 21:21:05 +03001353* The :meth:`mmap.flush() <mmap.mmap.flush>` method now returns ``None`` on
1354 success and raises an exception on error under all platforms. Previously,
1355 its behavior was platform-depended: a nonzero value was returned on success;
1356 zero was returned on error under Windows. A zero value was returned on
1357 success; an exception was raised on error under Unix.
1358 (Contributed by Berker Peksag in :issue:`2122`.)
1359
Andrés Delfinoca682612018-11-07 14:29:14 -03001360* :mod:`xml.dom.minidom` and :mod:`xml.sax` modules no longer process
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001361 external entities by default.
1362 (Contributed by Christian Heimes in :issue:`17239`.)
INADA Naokid5c875b2018-07-11 17:42:49 +09001363
Xiang Zhang4fb0b8b2018-12-12 20:46:55 +08001364* Deleting a key from a read-only :mod:`dbm` database (:mod:`dbm.dumb`,
1365 :mod:`dbm.gnu` or :mod:`dbm.ndbm`) raises :attr:`error` (:exc:`dbm.dumb.error`,
1366 :exc:`dbm.gnu.error` or :exc:`dbm.ndbm.error`) instead of :exc:`KeyError`.
1367 (Contributed by Xiang Zhang in :issue:`33106`.)
1368
Steve Dower8ef864d2019-03-12 15:15:26 -07001369* :func:`~os.path.expanduser` on Windows now prefers the :envvar:`USERPROFILE`
1370 environment variable and does not use :envvar:`HOME`, which is not normally
1371 set for regular user accounts.
1372
Steve Dower2438cdf2019-03-29 16:37:16 -07001373.. _bpo-36085-whatsnew:
1374
1375* DLL dependencies for extension modules and DLLs loaded with :mod:`ctypes` on
1376 Windows are now resolved more securely. Only the system paths, the directory
1377 containing the DLL or PYD file, and directories added with
1378 :func:`~os.add_dll_directory` are searched for load-time dependencies.
1379 Specifically, :envvar:`PATH` and the current working directory are no longer
1380 used, and modifications to these will no longer have any effect on normal DLL
1381 resolution. If your application relies on these mechanisms, you should check
1382 for :func:`~os.add_dll_directory` and if it exists, use it to add your DLLs
Steve Dower79da3882019-03-30 20:58:17 -07001383 directory while loading your library. Note that Windows 7 users will need to
1384 ensure that Windows Update KB2533625 has been installed (this is also verified
1385 by the installer).
Steve Dower2438cdf2019-03-29 16:37:16 -07001386 (See :issue:`36085`.)
1387
Pablo Galindof2cf1e32019-04-13 17:05:14 +01001388* The header files and functions related to pgen have been removed after its
1389 replacement by a pure Python implementation. (Contributed by Pablo Galindo
1390 in :issue:`36623`.)
1391
Pablo Galindo5d23e282019-05-12 22:45:52 +01001392* :class:`types.CodeType` has a new parameter in the second position of the
1393 constructor (*posonlyargcount*) to support positional-only arguments defined
Pablo Galindocd74e662019-06-01 18:08:04 +01001394 in :pep:`570`. The first argument (*argcount*) now represents the total
1395 number of positional arguments (including positional-only arguments). A new
1396 ``replace()`` method of :class:`types.CodeType` can be used to make the code
1397 future-proof.
Pablo Galindo5d23e282019-05-12 22:45:52 +01001398
Xiang Zhang4fb0b8b2018-12-12 20:46:55 +08001399
Inada Naokid3c72a22019-03-23 21:04:40 +09001400Changes in the C API
1401--------------------
1402
Victor Stinner2c9b4982019-06-13 02:01:29 +02001403* The :c:type:`PyCompilerFlags` structure gets a new *cf_feature_version*
1404 field. It should be initialized to ``PY_MINOR_VERSION``. The field is ignored
1405 by default, it is used if and only if ``PyCF_ONLY_AST`` flag is set in
1406 *cf_flags*.
1407
Victor Stinnerd5d9e812019-05-13 12:35:37 +02001408* The :c:func:`PyEval_ReInitThreads` function has been removed from the C API.
1409 It should not be called explicitly: use :c:func:`PyOS_AfterFork_Child`
1410 instead.
1411 (Contributed by Victor Stinner in :issue:`36728`.)
1412
E. M. Brayc994c8f2019-05-24 17:33:47 +02001413* On Unix, C extensions are no longer linked to libpython except on Android
1414 and Cygwin. When Python is embedded, ``libpython`` must not be loaded with
xdegaye254b3092019-04-29 09:27:40 +02001415 ``RTLD_LOCAL``, but ``RTLD_GLOBAL`` instead. Previously, using
E. M. Brayc994c8f2019-05-24 17:33:47 +02001416 ``RTLD_LOCAL``, it was already not possible to load C extensions which
1417 were not linked to ``libpython``, like C extensions of the standard
1418 library built by the ``*shared*`` section of ``Modules/Setup``.
Victor Stinner01ae8972019-06-03 16:28:01 +02001419 (Contributed by Victor Stinner in :issue:`21536`.)
Victor Stinner8c3ecc62019-04-25 20:13:10 +02001420
Inada Naokid3c72a22019-03-23 21:04:40 +09001421* Use of ``#`` variants of formats in parsing or building value (e.g.
1422 :c:func:`PyArg_ParseTuple`, :c:func:`Py_BuildValue`, :c:func:`PyObject_CallFunction`,
1423 etc.) without ``PY_SSIZE_T_CLEAN`` defined raises ``DeprecationWarning`` now.
1424 It will be removed in 3.10 or 4.0. Read :ref:`arg-parsing` for detail.
1425 (Contributed by Inada Naoki in :issue:`36381`.)
1426
Eddie Elizondo364f0b02019-03-27 07:52:18 -04001427* Instances of heap-allocated types (such as those created with
1428 :c:func:`PyType_FromSpec`) hold a reference to their type object.
1429 Increasing the reference count of these type objects has been moved from
1430 :c:func:`PyType_GenericAlloc` to the more low-level functions,
1431 :c:func:`PyObject_Init` and :c:func:`PyObject_INIT`.
1432 This makes types created through :c:func:`PyType_FromSpec` behave like
1433 other classes in managed code.
1434
1435 Statically allocated types are not affected.
1436
1437 For the vast majority of cases, there should be no side effect.
1438 However, types that manually increase the reference count after allocating
1439 an instance (perhaps to work around the bug) may now become immortal.
1440 To avoid this, these classes need to call Py_DECREF on the type object
1441 during instance deallocation.
1442
1443 To correctly port these types into 3.8, please apply the following
1444 changes:
1445
1446 * Remove :c:macro:`Py_INCREF` on the type object after allocating an
1447 instance - if any.
1448 This may happen after calling :c:func:`PyObject_New`,
1449 :c:func:`PyObject_NewVar`, :c:func:`PyObject_GC_New`,
1450 :c:func:`PyObject_GC_NewVar`, or any other custom allocator that uses
1451 :c:func:`PyObject_Init` or :c:func:`PyObject_INIT`.
1452
1453 Example::
1454
1455 static foo_struct *
1456 foo_new(PyObject *type) {
1457 foo_struct *foo = PyObject_GC_New(foo_struct, (PyTypeObject *) type);
1458 if (foo == NULL)
1459 return NULL;
1460 #if PY_VERSION_HEX < 0x03080000
1461 // Workaround for Python issue 35810; no longer necessary in Python 3.8
1462 PY_INCREF(type)
1463 #endif
1464 return foo;
1465 }
1466
1467 * Ensure that all custom ``tp_dealloc`` functions of heap-allocated types
1468 decrease the type's reference count.
1469
1470 Example::
1471
1472 static void
1473 foo_dealloc(foo_struct *instance) {
1474 PyObject *type = Py_TYPE(instance);
1475 PyObject_GC_Del(instance);
1476 #if PY_VERSION_HEX >= 0x03080000
1477 // This was not needed before Python 3.8 (Python issue 35810)
1478 Py_DECREF(type);
1479 #endif
1480 }
1481
1482 (Contributed by Eddie Elizondo in :issue:`35810`.)
1483
Zackery Spytz3c8724f2019-05-28 09:16:33 -06001484* The :c:macro:`Py_DEPRECATED()` macro has been implemented for MSVC.
1485 The macro now must be placed before the symbol name.
1486
1487 Example::
1488
1489 Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);
1490
1491 (Contributed by Zackery Spytz in :issue:`33407`.)
1492
Antoine Pitrouada319b2019-05-29 22:12:38 +02001493* The interpreter does not pretend to support binary compatibility of
Xtreak0d702272019-06-03 04:42:33 +05301494 extension types across feature releases, anymore. A :c:type:`PyTypeObject`
Antoine Pitrouada319b2019-05-29 22:12:38 +02001495 exported by a third-party extension module is supposed to have all the
1496 slots expected in the current Python version, including
1497 :c:member:`~PyTypeObject.tp_finalize` (:const:`Py_TPFLAGS_HAVE_FINALIZE`
1498 is not checked anymore before reading :c:member:`~PyTypeObject.tp_finalize`).
1499
1500 (Contributed by Antoine Pitrou in :issue:`32388`.)
1501
Pablo Galindo545a3b82019-05-31 19:33:41 +01001502* The :c:func:`PyCode_New` has a new parameter in the second position (*posonlyargcount*)
1503 to support :pep:`570`, indicating the number of positional-only arguments.
1504
Ivan Levkivskyi47c2de72019-06-19 01:17:47 +01001505* The functions :c:func:`PyNode_AddChild` and :c:func:`PyParser_AddToken` now accept
1506 two additional ``int`` arguments *end_lineno* and *end_col_offset*.
Eddie Elizondo364f0b02019-03-27 07:52:18 -04001507
Steve Dowerf5690922019-06-21 14:28:46 -07001508.. highlight:: shell
1509
1510* The :file:`libpython38.a` file to allow MinGW tools to link directly against
1511 :file:`python38.dll` is no longer included in the regular Windows distribution.
1512 If you require this file, it may be generated with the ``gendef`` and
1513 ``dlltool`` tools, which are part of the MinGW binutils package::
1514
1515 gendef python38.dll > tmp.def
1516 dlltool --dllname python38.dll --def tmp.def --output-lib libpython38.a
1517
1518 The location of an installed :file:`pythonXY.dll` will depend on the
1519 installation options and the version and language of Windows. See
1520 :ref:`using-on-windows` for more information. The resulting library should be
1521 placed in the same directory as :file:`pythonXY.lib`, which is generally the
1522 :file:`libs` directory under your Python installation.
1523
1524.. highlight:: python3
1525
1526
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001527CPython bytecode changes
1528------------------------
1529
1530* The interpreter loop has been simplified by moving the logic of unrolling
1531 the stack of blocks into the compiler. The compiler emits now explicit
Serhiy Storchaka3f819ca2018-10-31 02:26:06 +02001532 instructions for adjusting the stack of values and calling the
1533 cleaning-up code for :keyword:`break`, :keyword:`continue` and
1534 :keyword:`return`.
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001535
1536 Removed opcodes :opcode:`BREAK_LOOP`, :opcode:`CONTINUE_LOOP`,
1537 :opcode:`SETUP_LOOP` and :opcode:`SETUP_EXCEPT`. Added new opcodes
1538 :opcode:`ROT_FOUR`, :opcode:`BEGIN_FINALLY`, :opcode:`CALL_FINALLY` and
1539 :opcode:`POP_FINALLY`. Changed the behavior of :opcode:`END_FINALLY`
1540 and :opcode:`WITH_CLEANUP_START`.
1541
1542 (Contributed by Mark Shannon, Antoine Pitrou and Serhiy Storchaka in
1543 :issue:`17611`.)
Serhiy Storchaka702f8f32018-03-23 14:34:35 +02001544
1545* Added new opcode :opcode:`END_ASYNC_FOR` for handling exceptions raised
1546 when awaiting a next item in an :keyword:`async for` loop.
1547 (Contributed by Serhiy Storchaka in :issue:`33041`.)
Raymond Hettingerf75d59e2019-02-02 22:54:56 -08001548
Pablo Galindob51b7132019-06-25 02:41:58 +01001549* The :opcode:`MAP_ADD` now expects the value as the first element in the
1550 stack and the key as the second element. This change was made so the key
1551 is always evaluated before the value in dictionary comprehensions, as
Pablo Galindode9b6062019-06-25 11:55:23 +01001552 proposed by :pep:`572`. (Contributed by Jörn Heissler in :issue:`35224`.)
Pablo Galindob51b7132019-06-25 02:41:58 +01001553
Raymond Hettingerf75d59e2019-02-02 22:54:56 -08001554
1555Demos and Tools
1556---------------
1557
1558* Added a benchmark script for timing various ways to access variables:
1559 ``Tools/scripts/var_access_benchmark.py``.
1560 (Contributed by Raymond Hettinger in :issue:`35884`.)