blob: 99bb793830bc37ef1c1c2d542835e71da2818d72 [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
57 * :pep:`574` - Pickle protocol 5 with out-of-band data buffer support
58 * :pep:`578` - Runtime audit hooks for potentially sensitive operations
59 * ``python -m asyncio`` runs a natively async REPL
60 * ...
61
Ned Deily07a18922018-01-31 18:12:38 -050062
63Summary -- Release highlights
64=============================
65
66.. This section singles out the most important changes in Python 3.8.
67 Brevity is key.
68
69
70.. PEP-sized items next.
71
72
73
74New Features
75============
76
Guido van Rossum09d434c2019-04-24 11:30:17 -070077Assignment expressions
78----------------------
79
80There is new syntax (the "walrus operator", ``:=``) to assign values
81to variables as part of an expression. Example::
82
83 if (n := len(a)) > 10:
84 print(f"List is too long ({n} elements, expected <= 10)")
85
86See :pep:`572` for a full description.
87
88(Contributed by Emily Morehouse in :issue:`35224`.)
89
90.. TODO: Emily will sprint on docs at PyCon US 2019.
91
92
Guido van Rossum843bf422019-04-29 05:49:30 -070093Positional-only parameters
94--------------------------
95
96There is new syntax (``/``) to indicate that some function parameters
97must be specified positionally (i.e., cannot be used as keyword
98arguments). This is the same notation as shown by ``help()`` for
99functions implemented in C (produced by Larry Hastings' "Argument
100Clinic" tool). Example::
101
102 def pow(x, y, z=None, /):
103 r = x**y
104 if z is not None:
105 r %= z
106 return r
107
108Now ``pow(2, 10)`` and ``pow(2, 10, 17)`` are valid calls, but
109``pow(x=2, y=10)`` and ``pow(2, 10, z=17)`` are invalid.
110
111See :pep:`570` for a full description.
112
113(Contributed by Pablo Galindo in :issue:`36540`.)
114
115.. TODO: Pablo will sprint on docs at PyCon US 2019.
116
117
Nick Coghlan16eb3bc2018-06-20 21:25:01 +1000118Parallel filesystem cache for compiled bytecode files
119-----------------------------------------------------
120
121The new :envvar:`PYTHONPYCACHEPREFIX` setting (also available as
122:option:`-X` ``pycache_prefix``) configures the implicit bytecode
123cache to use a separate parallel filesystem tree, rather than
124the default ``__pycache__`` subdirectories within each source
125directory.
126
127The location of the cache is reported in :data:`sys.pycache_prefix`
128(:const:`None` indicates the default location in ``__pycache__``
129subdirectories).
130
131(Contributed by Carl Meyer in :issue:`33499`.)
Ned Deily07a18922018-01-31 18:12:38 -0500132
Victor Stinner40460692019-04-26 17:56:44 +0200133Debug build uses the same ABI as release build
134-----------------------------------------------
135
Paul Ganssle5c403b22019-04-27 14:14:35 -0400136Python now uses the same ABI whether it built in release or debug mode. On
137Unix, when Python is built in debug mode, it is now possible to load C
138extensions built in release mode and C extensions built using the stable ABI.
Victor Stinner40460692019-04-26 17:56:44 +0200139
Paul Ganssle5c403b22019-04-27 14:14:35 -0400140Release builds and debug builds are now ABI compatible: defining the
141``Py_DEBUG`` macro no longer implies the ``Py_TRACE_REFS`` macro, which
142introduces the only ABI incompatibility. The ``Py_TRACE_REFS`` macro, which
143adds the :func:`sys.getobjects` function and the :envvar:`PYTHONDUMPREFS`
144environment variable, can be set using the new ``./configure --with-trace-refs``
145build option.
Victor Stinner40460692019-04-26 17:56:44 +0200146(Contributed by Victor Stinner in :issue:`36465`.)
147
E. M. Brayc994c8f2019-05-24 17:33:47 +0200148On Unix, C extensions are no longer linked to libpython except on Android
149and Cygwin.
Victor Stinner4ebcd7e2019-05-11 04:10:03 +0200150It is now possible
Paul Ganssle5c403b22019-04-27 14:14:35 -0400151for a statically linked Python to load a C extension built using a shared
152library Python.
Victor Stinner40460692019-04-26 17:56:44 +0200153(Contributed by Victor Stinner in :issue:`21536`.)
154
155On Unix, when Python is built in debug mode, import now also looks for C
156extensions compiled in release mode and for C extensions compiled with the
157stable ABI.
158(Contributed by Victor Stinner in :issue:`36722`.)
159
Victor Stinner0a8e5722019-05-23 03:30:23 +0200160To embed Python into an application, a new ``--embed`` option must be passed to
161``python3-config --libs --embed`` to get ``-lpython3.8`` (link the application
162to libpython). To support both 3.8 and older, try ``python3-config --libs
163--embed`` first and fallback to ``python3-config --libs`` (without ``--embed``)
164if the previous command fails.
165
166Add a pkg-config ``python-3.8-embed`` module to embed Python into an
167application: ``pkg-config python-3.8-embed --libs`` includes ``-lpython3.8``.
168To support both 3.8 and older, try ``pkg-config python-X.Y-embed --libs`` first
169and fallback to ``pkg-config python-X.Y --libs`` (without ``--embed``) if the
170previous command fails (replace ``X.Y`` with the Python version).
171
172On the other hand, ``pkg-config python3.8 --libs`` no longer contains
173``-lpython3.8``. C extensions must not be linked to libpython (except on
E. M. Brayc994c8f2019-05-24 17:33:47 +0200174Android and Cygwin, whose cases are handled by the script);
175this change is backward incompatible on purpose.
Victor Stinner0a8e5722019-05-23 03:30:23 +0200176(Contributed by Victor Stinner in :issue:`36721`.)
177
Eric V. Smith9a4135e2019-05-08 16:28:48 -0400178f-strings now support = for quick and easy debugging
179-----------------------------------------------------
180
181Add ``=`` specifier to f-strings. ``f'{expr=}'`` expands
182to the text of the expression, an equal sign, then the repr of the
183evaluated expression. So::
184
185 x = 3
186 print(f'{x*9 + 15=}')
187
188Would print ``x*9 + 15=42``.
189
190(Contributed by Eric V. Smith and Larry Hastings in :issue:`36817`.)
191
Victor Stinner331a6a52019-05-27 16:39:22 +0200192PEP 587: Python Initialization Configuration
193--------------------------------------------
194
195The :pep:`587` adds a new C API to configure the Python Initialization
196providing finer control on the whole configuration and better error reporting.
197
198New structures:
199
200* :c:type:`PyConfig`
201* :c:type:`PyPreConfig`
202* :c:type:`PyStatus`
203* :c:type:`PyWideStringList`
204
205New functions:
206
207* :c:func:`PyConfig_Clear`
208* :c:func:`PyConfig_InitIsolatedConfig`
209* :c:func:`PyConfig_InitPythonConfig`
210* :c:func:`PyConfig_Read`
211* :c:func:`PyConfig_SetArgv`
212* :c:func:`PyConfig_SetBytesArgv`
213* :c:func:`PyConfig_SetBytesString`
214* :c:func:`PyConfig_SetString`
215* :c:func:`PyPreConfig_InitIsolatedConfig`
216* :c:func:`PyPreConfig_InitPythonConfig`
217* :c:func:`PyStatus_Error`
218* :c:func:`PyStatus_Exception`
219* :c:func:`PyStatus_Exit`
220* :c:func:`PyStatus_IsError`
221* :c:func:`PyStatus_IsExit`
222* :c:func:`PyStatus_NoMemory`
223* :c:func:`PyStatus_Ok`
224* :c:func:`PyWideStringList_Append`
225* :c:func:`PyWideStringList_Insert`
226* :c:func:`Py_BytesMain`
227* :c:func:`Py_ExitStatusException`
228* :c:func:`Py_InitializeFromConfig`
229* :c:func:`Py_PreInitialize`
230* :c:func:`Py_PreInitializeFromArgs`
231* :c:func:`Py_PreInitializeFromBytesArgs`
232* :c:func:`Py_RunMain`
233
234This PEP also adds ``_PyRuntimeState.preconfig`` (:c:type:`PyPreConfig` type)
235and ``PyInterpreterState.config`` (:c:type:`PyConfig` type) fields to these
236internal structures. ``PyInterpreterState.config`` becomes the new
237reference configuration, replacing global configuration variables and
238other private variables.
239
240See :ref:`Python Initialization Configuration <init-config>` for the
241documentation.
242
243See :pep:`587` for a full description.
244
245(Contributed by Victor Stinner in :issue:`36763`.)
246
Ned Deily07a18922018-01-31 18:12:38 -0500247
Jeroen Demeyer9e3e06e2019-06-03 01:43:13 +0200248Vectorcall: a fast calling protocol for CPython
249-----------------------------------------------
250
251The "vectorcall" protocol is added to the Python/C API.
252It is meant to formalize existing optimizations which were already done
253for various classes.
254Any extension type implementing a callable can use this protocol.
255
256This is currently provisional,
257the aim is to make it fully public in Python 3.9.
258
259See :pep:`590` for a full description.
260
261(Contributed by Jeroen Demeyer and Mark Shannon in :issue:`36974`.)
262
263
Ned Deily07a18922018-01-31 18:12:38 -0500264Other Language Changes
265======================
266
Serhiy Storchakafe2bbb12018-03-18 09:56:52 +0200267* A :keyword:`continue` statement was illegal in the :keyword:`finally` clause
268 due to a problem with the implementation. In Python 3.8 this restriction
269 was lifted.
270 (Contributed by Serhiy Storchaka in :issue:`32489`.)
271
Serhiy Storchakab2e20252018-10-20 00:46:31 +0300272* The :class:`int` type now has a new :meth:`~int.as_integer_ratio` method
273 compatible with the existing :meth:`float.as_integer_ratio` method.
Lisa Roach5ac70432018-09-13 23:56:23 -0700274 (Contributed by Lisa Roach in :issue:`33073`.)
275
Serhiy Storchakabdbad712019-06-02 00:05:48 +0300276* Constructors of :class:`int`, :class:`float` and :class:`complex` will now
277 use the :meth:`~object.__index__` special method, if available and the
278 corresponding method :meth:`~object.__int__`, :meth:`~object.__float__`
279 or :meth:`~object.__complex__` is not available.
280 (Contributed by Serhiy Storchaka in :issue:`20092`.)
281
Serhiy Storchakaa445feb2018-02-10 00:08:17 +0200282* Added support of ``\N{name}`` escapes in :mod:`regular expressions <re>`.
283 (Contributed by Jonathan Eunice and Serhiy Storchaka in :issue:`30688`.)
Ned Deily07a18922018-01-31 18:12:38 -0500284
Rémi Lapeyre6531bf62018-11-06 01:38:54 +0100285* Dict and dictviews are now iterable in reversed insertion order using
286 :func:`reversed`. (Contributed by Rémi Lapeyre in :issue:`33462`.)
287
Benjamin Petersonc9a71dd2018-09-12 17:14:39 -0700288* The syntax allowed for keyword names in function calls was further
289 restricted. In particular, ``f((keyword)=arg)`` is no longer allowed. It was
290 never intended to permit more than a bare name on the left-hand side of a
291 keyword argument assignment term. See :issue:`34641`.
Ned Deily07a18922018-01-31 18:12:38 -0500292
jChapman8fabae32018-09-22 21:13:10 -0400293* Iterable unpacking is now allowed without parentheses in :keyword:`yield`
294 and :keyword:`return` statements.
295 (Contributed by David Cuthbert and Jordan Chapman in :issue:`32117`.)
296
Serhiy Storchaka65439122018-10-19 17:42:06 +0300297* A backslash-character pair that is not a valid escape sequence generates
298 a :exc:`DeprecationWarning` since Python 3.6. In Python 3.8 it generates
299 a :exc:`SyntaxWarning` instead.
300 (Contributed by Serhiy Storchaka in :issue:`32912`.)
301
Serhiy Storchaka62e44812019-02-16 08:12:19 +0200302* The compiler now produces a :exc:`SyntaxWarning` in some cases when a comma
303 is missed before tuple or list. For example::
304
305 data = [
306 (1, 2, 3) # oops, missing comma!
307 (4, 5, 6)
308 ]
309
310 (Contributed by Serhiy Storchaka in :issue:`15248`.)
311
Paul Ganssled9503c32019-02-08 11:02:00 -0500312* Arithmetic operations between subclasses of :class:`datetime.date` or
313 :class:`datetime.datetime` and :class:`datetime.timedelta` objects now return
314 an instance of the subclass, rather than the base class. This also affects
315 the return type of operations whose implementation (directly or indirectly)
316 uses :class:`datetime.timedelta` arithmetic, such as
317 :meth:`datetime.datetime.astimezone`.
318 (Contributed by Paul Ganssle in :issue:`32417`.)
319
Gregory P. Smith06babb22019-02-23 10:43:49 -0800320* When the Python interpreter is interrupted by Ctrl-C (SIGINT) and the
321 resulting :exc:`KeyboardInterrupt` exception is not caught, the Python process
322 now exits via a SIGINT signal or with the correct exit code such that the
323 calling process can detect that it died due to a Ctrl-C. Shells on POSIX
324 and Windows use this to properly terminate scripts in interactive sessions.
325 (Contributed by Google via Gregory P. Smith in :issue:`1054041`.)
326
Victor Stinnera9f05d62019-05-24 23:57:23 +0200327* Added new ``replace()`` method to the code type (:class:`types.CodeType`).
328 (Contributed by Victor Stinner in :issue:`37032`.)
329
Mark Dickinsonc5299672019-06-02 10:24:06 +0100330* For integers, the three-argument form of the :func:`pow` function now permits
331 the exponent to be negative in the case where the base is relatively prime to
332 the modulus. It then computes a modular inverse to the base when the exponent
333 is ``-1``, and a suitable power of that inverse for other negative exponents.
334 (Contributed by Mark Dickinson in :issue:`36027`.)
335
Serhiy Storchaka65439122018-10-19 17:42:06 +0300336
Ned Deily07a18922018-01-31 18:12:38 -0500337New Modules
338===========
339
Barry Warsaw4867eaa2019-06-05 19:40:19 -0700340* The new :mod:`importlib.metadata` module provides (provisional) support for
341 reading metadata from third-party packages. For example, you can extract an
342 installed package's version number, list of entry points, and more. See
343 :issue:`34632` for additional details.
Ned Deily07a18922018-01-31 18:12:38 -0500344
345
346Improved Modules
347================
348
Raymond Hettinger0bb4bdf2019-01-31 00:59:50 -0800349
Victor Stinner6ea29c52018-09-25 08:27:08 -0700350asyncio
351-------
352
353On Windows, the default event loop is now :class:`~asyncio.ProactorEventLoop`.
Victor Stinner01ae8972019-06-03 16:28:01 +0200354(Contributed by Victor Stinner in :issue:`34687`.)
355
356:class:`~asyncio.ProactorEventLoop` now also supports UDP.
357(Contributed by Adam Meily and Andrew Svetlov in :issue:`29883`.)
358
359:class:`~asyncio.ProactorEventLoop` can now be interrupted by
360:exc:`KeyboardInterrupt` ("CTRL+C").
361(Contributed by Vladimir Matveev in :issue:`23057`.)
362
Victor Stinner6ea29c52018-09-25 08:27:08 -0700363
Matthias Bussonnier2ddbd212019-05-22 12:07:45 -0700364builtins
365--------
366
367The :func:`compile` built-in has been improved to accept the
368``ast.PyCF_ALLOW_TOP_LEVEL_AWAIT`` flag. With this new flag passed,
369:func:`compile` will allow top-level ``await``, ``async for`` and ``async with``
370constructs that are usually considered invalid syntax. Asynchronous code object
371marked with the ``CO_COROUTINE`` flag may then be returned.
372
373(Contributed by Matthias Bussonnier in :issue:`34616`)
Terry Jan Reedyfdcb5ae2018-09-25 12:45:27 -0400374
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700375collections
376-----------
377
378The :meth:`_asdict()` method for :func:`collections.namedtuple` now returns
Daniel Porteous05222912019-05-02 04:20:59 -0400379a :class:`dict` instead of a :class:`collections.OrderedDict`. This works because
380regular dicts have guaranteed ordering since Python 3.7. If the extra
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700381features of :class:`OrderedDict` are required, the suggested remediation is
382to cast the result to the desired type: ``OrderedDict(nt._asdict())``.
383(Contributed by Raymond Hettinger in :issue:`35864`.)
384
385
Steve Dower2438cdf2019-03-29 16:37:16 -0700386ctypes
387------
388
389On Windows, :class:`~ctypes.CDLL` and subclasses now accept a *winmode* parameter
390to specify flags for the underlying ``LoadLibraryEx`` call. The default flags are
391set to only load DLL dependencies from trusted locations, including the path
392where the DLL is stored (if a full or partial path is used to load the initial
393DLL) and paths added by :func:`~os.add_dll_directory`.
394
395
Raymond Hettingerb8218682019-05-26 11:27:35 -0700396functools
397---------
398
399:func:`functools.lru_cache` can now be used as a straight decorator rather
400than as a function returning a decorator. So both of these are now supported::
401
402 @lru_cache
403 def f(x):
404 ...
405
406 @lru_cache(maxsize=256)
407 def f(x):
408 ...
409
410(Contributed by Raymond Hettinger in :issue:`36772`.)
411
412
Paul Ganssle88c09372019-04-29 09:22:03 -0400413datetime
414--------
415
416Added new alternate constructors :meth:`datetime.date.fromisocalendar` and
417:meth:`datetime.datetime.fromisocalendar`, which construct :class:`date` and
418:class:`datetime` objects respectively from ISO year, week number and weekday;
419these are the inverse of each class's ``isocalendar`` method.
420(Contributed by Paul Ganssle in :issue:`36004`.)
421
422
Cheryl Sabella637a33b2018-11-07 09:12:20 -0500423gettext
424-------
425
426Added :func:`~gettext.pgettext` and its variants.
427(Contributed by Franz Glasner, Éric Araujo, and Cheryl Sabella in :issue:`2504`.)
428
Raymond Hettingerd1e768a2019-03-25 13:01:13 -0700429inspect
430-------
431
432The :func:`inspect.getdoc` function can now find docstrings for ``__slots__``
433if that attribute is a :class:`dict` where the values are docstrings.
434This provides documentation options similar to what we already have
435for :func:`property`, :func:`classmethod`, and :func:`staticmethod`::
436
437 class AudioClip:
438 __slots__ = {'bit_rate': 'expressed in kilohertz to one decimal place',
439 'duration': 'in seconds, rounded up to an integer'}
440 def __init__(self, bit_rate, duration):
441 self.bit_rate = round(bit_rate / 1000.0, 1)
442 self.duration = ceil(duration)
Pablo Galindo175421b2019-02-23 03:02:06 +0000443
Victor Stinnerbc2aa812019-05-23 03:45:09 +0200444io
445--
446
447In development mode (:option:`-X` ``env``) and in debug build, the
448:class:`io.IOBase` finalizer now logs the exception if the ``close()`` method
449fails. The exception is ignored silently by default in release build.
450(Contributed by Victor Stinner in :issue:`18748`.)
451
452
Pablo Galindo175421b2019-02-23 03:02:06 +0000453gc
454--
455
456:func:`~gc.get_objects` can now receive an optional *generation* parameter
457indicating a generation to get objects from. Contributed in
458:issue:`36016` by Pablo Galindo.
459
460
guoci0e7497c2018-11-07 04:50:23 -0500461gzip
462----
463
464Added the *mtime* parameter to :func:`gzip.compress` for reproducible output.
465(Contributed by Guo Ci Teo in :issue:`34898`.)
466
Zackery Spytzcf599f62019-05-13 01:50:52 -0600467A :exc:`~gzip.BadGzipFile` exception is now raised instead of :exc:`OSError`
468for certain types of invalid or corrupt gzip files.
469(Contributed by Filip Gruszczyński, Michele Orrù, and Zackery Spytz in
470:issue:`6584`.)
471
guoci0e7497c2018-11-07 04:50:23 -0500472
Terry Jan Reedyfdcb5ae2018-09-25 12:45:27 -0400473idlelib and IDLE
474----------------
475
476Output over N lines (50 by default) is squeezed down to a button.
477N can be changed in the PyShell section of the General page of the
478Settings dialog. Fewer, but possibly extra long, lines can be squeezed by
479right clicking on the output. Squeezed output can be expanded in place
480by double-clicking the button or into the clipboard or a separate window
481by right-clicking the button. (Contributed by Tal Einat in :issue:`1529353`.)
482
483The changes above have been backported to 3.7 maintenance releases.
484
485
HongWeipengf1944792018-11-07 18:09:32 +0800486json.tool
487---------
488
489Add option ``--json-lines`` to parse every input line as separate JSON object.
490(Contributed by Weipeng Hong in :issue:`31553`.)
491
Pablo Galindobc098512019-02-07 07:04:02 +0000492
493math
494----
495
Raymond Hettinger3ff59622019-02-16 11:00:42 -0800496Added new function :func:`math.dist` for computing Euclidean distance
497between two points. (Contributed by Raymond Hettinger in :issue:`33089`.)
498
499Expanded the :func:`math.hypot` function to handle multiple dimensions.
500Formerly, it only supported the 2-D case.
501(Contributed by Raymond Hettinger in :issue:`33089`.)
502
Pablo Galindobc098512019-02-07 07:04:02 +0000503Added new function, :func:`math.prod`, as analogous function to :func:`sum`
504that returns the product of a 'start' value (default: 1) times an iterable of
Raymond Hettinger3ff59622019-02-16 11:00:42 -0800505numbers. (Contributed by Pablo Galindo in :issue:`35606`)
Pablo Galindobc098512019-02-07 07:04:02 +0000506
Mark Dickinson73934b92019-05-18 12:29:50 +0100507Added new function :func:`math.isqrt` for computing integer square roots.
508(Contributed by Mark Dickinson in :issue:`36887`.)
509
Mark Dickinsona0adffb2019-06-01 12:21:53 +0100510The function :func:`math.factorial` no longer accepts arguments that are not
511int-like. (Contributed by Pablo Galindo in :issue:`33083`.)
512
Zackery Spytz02db6962019-05-27 10:48:17 -0600513
514mmap
515----
516
517The :class:`mmap.mmap` class now has an :meth:`~mmap.mmap.madvise` method to
518access the ``madvise()`` system call.
519(Contributed by Zackery Spytz in :issue:`32941`.)
520
521
Victor Stinner17a55882019-05-28 16:02:50 +0200522multiprocessing
523---------------
524
525Added new :mod:`multiprocessing.shared_memory` module.
526(Contributed Davin Potts in :issue:`35813`.)
527
528On macOS, the *spawn* start method is now used by default.
529(Contributed by Victor Stinner in :issue:`33725`.)
530
531
Steve Dower2438cdf2019-03-29 16:37:16 -0700532os
533--
534
535Added new function :func:`~os.add_dll_directory` on Windows for providing
536additional search paths for native dependencies when importing extension
537modules or loading DLLs using :mod:`ctypes`.
538
Zackery Spytz43fdbd22019-05-29 13:57:07 -0600539A new :func:`os.memfd_create` function was added to wrap the
540``memfd_create()`` syscall.
541(Contributed by Zackery Spytz and Christian Heimes in :issue:`26836`.)
542
Pablo Galindobc098512019-02-07 07:04:02 +0000543
Serhiy Storchaka0185f342018-09-18 11:28:51 +0300544os.path
545-------
546
547:mod:`os.path` functions that return a boolean result like
548:func:`~os.path.exists`, :func:`~os.path.lexists`, :func:`~os.path.isdir`,
549:func:`~os.path.isfile`, :func:`~os.path.islink`, and :func:`~os.path.ismount`
550now return ``False`` instead of raising :exc:`ValueError` or its subclasses
551:exc:`UnicodeEncodeError` and :exc:`UnicodeDecodeError` for paths that contain
552characters or bytes unrepresentable at the OS level.
553(Contributed by Serhiy Storchaka in :issue:`33721`.)
554
Steve Dower8ef864d2019-03-12 15:15:26 -0700555:func:`~os.path.expanduser` on Windows now prefers the :envvar:`USERPROFILE`
556environment variable and does not use :envvar:`HOME`, which is not normally set
557for regular user accounts.
558
Serhiy Storchakab232df92018-10-30 13:22:42 +0200559
560ncurses
561-------
562
563Added a new variable holding structured version information for the
564underlying ncurses library: :data:`~curses.ncurses_version`.
565(Contributed by Serhiy Storchaka in :issue:`31680`.)
566
567
Serhiy Storchaka0185f342018-09-18 11:28:51 +0300568pathlib
569-------
570
571:mod:`pathlib.Path` methods that return a boolean result like
572:meth:`~pathlib.Path.exists()`, :meth:`~pathlib.Path.is_dir()`,
573:meth:`~pathlib.Path.is_file()`, :meth:`~pathlib.Path.is_mount()`,
574:meth:`~pathlib.Path.is_symlink()`, :meth:`~pathlib.Path.is_block_device()`,
575:meth:`~pathlib.Path.is_char_device()`, :meth:`~pathlib.Path.is_fifo()`,
576:meth:`~pathlib.Path.is_socket()` now return ``False`` instead of raising
577:exc:`ValueError` or its subclass :exc:`UnicodeEncodeError` for paths that
578contain characters unrepresentable at the OS level.
579(Contributed by Serhiy Storchaka in :issue:`33721`.)
580
Joannah Nanjekye6b5b0132019-05-04 11:27:10 -0400581Added :meth:`pathlib.Path.link_to()` which creates a hard link pointing
582to a path.
583(Contributed by Joannah Nanjekye in :issue:`26978`)
584
jab9e00d9e2018-12-28 13:03:40 -0500585
Jon Janzenc981ad12019-05-15 22:14:38 +0200586plistlib
587--------
588
589Added new :class:`plistlib.UID` and enabled support for reading and writing
590NSKeyedArchiver-encoded binary plists.
591(Contributed by Jon Janzen in :issue:`26707`.)
592
593
Joannah Nanjekye2e33ecd2019-05-28 13:29:04 -0300594py_compile
595----------
596
597:func:`py_compile.compile` now supports silent mode.
598(Contributed by Joannah Nanjekye in :issue:`22640`.)
599
600
Giampaolo Rodolaeb7e29f2019-04-09 00:34:02 +0200601socket
602------
603
604Added :meth:`~socket.create_server()` and :meth:`~socket.has_dualstack_ipv6()`
605convenience functions to automate the necessary tasks usually involved when
606creating a server socket, including accepting both IPv4 and IPv6 connections
607on the same socket. (Contributed by Giampaolo Rodola in :issue:`17561`.)
608
Zackery Spytz8f96c9f2019-05-29 15:02:37 -0600609The :func:`socket.if_nameindex()`, :func:`socket.if_nametoindex()`, and
610:func:`socket.if_indextoname()` functions have been implemented on Windows.
611(Contributed by Zackery Spytz in :issue:`37007`.)
612
Bo Baylesca804952019-05-29 03:06:12 -0500613shlex
614----------
615
616The new :func:`shlex.join` function acts as the inverse of :func:`shlex.split`.
617(Contributed by Bo Bayles in :issue:`32102`.)
Giampaolo Rodolaeb7e29f2019-04-09 00:34:02 +0200618
jab9e00d9e2018-12-28 13:03:40 -0500619shutil
620------
621
622:func:`shutil.copytree` now accepts a new ``dirs_exist_ok`` keyword argument.
623(Contributed by Josh Bronson in :issue:`20849`.)
624
CAM Gerlach89a89442019-04-06 23:47:49 -0500625:func:`shutil.make_archive` now defaults to the modern pax (POSIX.1-2001)
626format for new archives to improve portability and standards conformance,
627inherited from the corresponding change to the :mod:`tarfile` module.
628(Contributed by C.A.M. Gerlach in :issue:`30661`.)
629
jab9e00d9e2018-12-28 13:03:40 -0500630
Christian Heimes9fb051f2018-09-23 08:32:31 +0200631ssl
632---
633
634Added :attr:`SSLContext.post_handshake_auth` to enable and
635:meth:`ssl.SSLSocket.verify_client_post_handshake` to initiate TLS 1.3
636post-handshake authentication.
637(Contributed by Christian Heimes in :issue:`34670`.)
638
Raymond Hettinger47d99872019-02-21 15:06:29 -0800639
640statistics
641----------
642
643Added :func:`statistics.fmean` as a faster, floating point variant of
644:func:`statistics.mean()`. (Contributed by Raymond Hettinger and
645Steven D'Aprano in :issue:`35904`.)
646
Raymond Hettinger6463ba32019-04-07 09:20:03 -0700647Added :func:`statistics.geometric_mean()`
648(Contributed by Raymond Hettinger in :issue:`27181`.)
649
Raymond Hettingerfc06a192019-03-12 00:43:27 -0700650Added :func:`statistics.multimode` that returns a list of the most
651common values. (Contributed by Raymond Hettinger in :issue:`35892`.)
652
Raymond Hettinger9013ccf2019-04-23 00:06:35 -0700653Added :func:`statistics.quantiles` that divides data or a distribution
654in to equiprobable intervals (e.g. quartiles, deciles, or percentiles).
655(Contributed by Raymond Hettinger in :issue:`36546`.)
656
Raymond Hettinger11c79532019-02-23 14:44:07 -0800657Added :class:`statistics.NormalDist`, a tool for creating
658and manipulating normal distributions of a random variable.
659(Contributed by Raymond Hettinger in :issue:`36018`.)
660
661::
662
663 >>> temperature_feb = NormalDist.from_samples([4, 12, -3, 2, 7, 14])
Raymond Hettinger671d7822019-05-01 17:49:12 -0700664 >>> temperature_feb.mean
665 6.0
666 >>> temperature_feb.stdev
667 6.356099432828281
Raymond Hettinger11c79532019-02-23 14:44:07 -0800668
669 >>> temperature_feb.cdf(3) # Chance of being under 3 degrees
670 0.3184678262814532
671 >>> # Relative chance of being 7 degrees versus 10 degrees
672 >>> temperature_feb.pdf(7) / temperature_feb.pdf(10)
673 1.2039930378537762
674
Raymond Hettinger671d7822019-05-01 17:49:12 -0700675 >>> el_niño = NormalDist(4, 2.5)
676 >>> temperature_feb += el_niño # Add in a climate effect
Raymond Hettinger11c79532019-02-23 14:44:07 -0800677 >>> temperature_feb
678 NormalDist(mu=10.0, sigma=6.830080526611674)
679
680 >>> temperature_feb * (9/5) + 32 # Convert to Fahrenheit
681 NormalDist(mu=50.0, sigma=12.294144947901014)
682 >>> temperature_feb.samples(3) # Generate random samples
683 [7.672102882379219, 12.000027119750287, 4.647488369766392]
684
Raymond Hettinger47d99872019-02-21 15:06:29 -0800685
Victor Stinneref9d9b62019-05-22 11:28:22 +0200686sys
687---
688
689Add new :func:`sys.unraisablehook` function which can be overridden to control
690how "unraisable exceptions" are handled. It is called when an exception has
691occurred but there is no way for Python to handle it. For example, when a
692destructor raises an exception or during garbage collection
693(:func:`gc.collect`).
Victor Stinner01ae8972019-06-03 16:28:01 +0200694(Contributed by Victor Stinner in :issue:`36829`.)
Victor Stinneref9d9b62019-05-22 11:28:22 +0200695
696
CAM Gerlache680c3d2019-03-21 09:44:51 -0500697tarfile
698-------
699
700The :mod:`tarfile` module now defaults to the modern pax (POSIX.1-2001)
701format for new archives, instead of the previous GNU-specific one.
702This improves cross-platform portability with a consistent encoding (UTF-8)
703in a standardized and extensible format, and offers several other benefits.
704(Contributed by C.A.M. Gerlach in :issue:`36268`.)
705
706
Victor Stinnercd590a72019-05-28 00:39:52 +0200707threading
708---------
709
710Add a new :func:`threading.excepthook` function which handles uncaught
711:meth:`threading.Thread.run` exception. It can be overridden to control how
712uncaught :meth:`threading.Thread.run` exceptions are handled.
713(Contributed by Victor Stinner in :issue:`1230540`.)
714
715
Tal Einatdfba1f62018-10-24 10:20:05 +0300716tokenize
717--------
718
719The :mod:`tokenize` module now implicitly emits a ``NEWLINE`` token when
720provided with input that does not have a trailing new line. This behavior
721now matches what the C tokenizer does internally.
722(Contributed by Ammar Askar in :issue:`33899`.)
723
Juliette Monselaf5658a2018-10-08 18:29:24 +0200724tkinter
725-------
726
727Added methods :meth:`~tkinter.Spinbox.selection_from`,
728:meth:`~tkinter.Spinbox.selection_present`,
729:meth:`~tkinter.Spinbox.selection_range` and
730:meth:`~tkinter.Spinbox.selection_to`
731in the :class:`tkinter.Spinbox` class.
732(Contributed by Juliette Monsel in :issue:`34829`.)
733
Juliette Monselbf034712018-10-12 18:44:10 +0200734Added method :meth:`~tkinter.Canvas.moveto`
735in the :class:`tkinter.Canvas` class.
736(Contributed by Juliette Monsel in :issue:`23831`.)
737
Zackery Spytz50866e92019-04-05 04:17:13 -0600738The :class:`tkinter.PhotoImage` class now has
739:meth:`~tkinter.PhotoImage.transparency_get` and
740:meth:`~tkinter.PhotoImage.transparency_set` methods. (Contributed by
741Zackery Spytz in :issue:`25451`.)
742
Joannah Nanjekye572168a2019-01-10 19:56:38 +0300743time
744----
745
746Added new clock :data:`~time.CLOCK_UPTIME_RAW` for macOS 10.12.
747(Contributed by Joannah Nanjekye in :issue:`35702`.)
748
Max Bélanger2810dd72018-11-04 15:58:24 -0800749unicodedata
750-----------
751
Benjamin Peterson3aca40d2019-05-08 20:59:35 -0700752* The :mod:`unicodedata` module has been upgraded to use the `Unicode 12.1.0
753 <http://blog.unicode.org/2019/05/unicode-12-1-en.html>`_ release.
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700754
Max Bélanger2810dd72018-11-04 15:58:24 -0800755* New function :func:`~unicodedata.is_normalized` can be used to verify a string
756 is in a specific normal form. (Contributed by Max Belanger and David Euresti in
757 :issue:`32285`).
758
Raymond Hettinger482b6b52019-05-01 17:48:13 -0700759
Lisa Roach0f221d02018-11-08 18:34:33 -0800760unittest
761--------
762
Victor Stinner01ae8972019-06-03 16:28:01 +0200763* Added :class:`AsyncMock` to support an asynchronous version of :class:`Mock`.
Lisa Roach77b3b772019-05-20 09:19:53 -0700764 Appropriate new assert functions for testing have been added as well.
765 (Contributed by Lisa Roach in :issue:`26467`).
766
Lisa Roach0f221d02018-11-08 18:34:33 -0800767* Added :func:`~unittest.addModuleCleanup()` and
768 :meth:`~unittest.TestCase.addClassCleanup()` to unittest to support
769 cleanups for :func:`~unittest.setUpModule()` and
770 :meth:`~unittest.TestCase.setUpClass()`.
771 (Contributed by Lisa Roach in :issue:`24412`.)
772
Petter Strandmark001d63c2019-06-04 21:34:49 +0200773* Several mock assert functions now also print a list of actual calls upon
774 failure. (Contributed by Petter Strandmark in :issue:`35047`.)
775
Brett Cannond64ee1a2018-09-21 15:27:26 -0700776venv
777----
778
779* :mod:`venv` now includes an ``Activate.ps1`` script on all platforms for
780 activating virtual environments under PowerShell Core 6.1.
781 (Contributed by Brett Cannon in :issue:`32718`.)
782
Mark Dickinson7abb6c02019-04-26 15:56:15 +0900783weakref
784-------
785
786* The proxy objects returned by :func:`weakref.proxy` now support the matrix
787 multiplication operators ``@`` and ``@=`` in addition to the other
788 numeric operators. (Contributed by Mark Dickinson in :issue:`36669`.)
789
Christian Heimes17b1d5d2018-09-23 09:50:25 +0200790xml
791---
792
793* As mitigation against DTD and external entity retrieval, the
Andrés Delfinoca682612018-11-07 14:29:14 -0300794 :mod:`xml.dom.minidom` and :mod:`xml.sax` modules no longer process
Christian Heimes17b1d5d2018-09-23 09:50:25 +0200795 external entities by default.
796 (Contributed by Christian Heimes in :issue:`17239`.)
797
Stefan Behnel47541682019-05-03 20:58:16 +0200798* The ``.find*()`` methods in the :mod:`xml.etree.ElementTree` module
799 support wildcard searches like ``{*}tag`` which ignores the namespace
800 and ``{namespace}*`` which returns all tags in the given namespace.
801 (Contributed by Stefan Behnel in :issue:`28238`.)
802
Stefan Behnele1d5dd62019-05-01 22:34:13 +0200803* The :mod:`xml.etree.ElementTree` module provides a new function
804 :func:`–xml.etree.ElementTree.canonicalize()` that implements C14N 2.0.
805 (Contributed by Stefan Behnel in :issue:`13611`.)
806
Stefan Behnele9a465f2019-05-10 10:25:13 +0200807* The target object of :class:`xml.etree.ElementTree.XMLParser` can
808 receive namespace declaration events through the new callback methods
809 ``start_ns()`` and ``end_ns()``. Additionally, the
810 :class:`xml.etree.ElementTree.TreeBuilder` target can be configured
811 to process events about comments and processing instructions to include
812 them in the generated tree.
813 (Contributed by Stefan Behnel in :issue:`36676` and :issue:`36673`.)
Christian Heimes17b1d5d2018-09-23 09:50:25 +0200814
Ned Deily07a18922018-01-31 18:12:38 -0500815Optimizations
816=============
817
Victor Stinner9daecf32019-01-16 00:02:35 +0100818* The :mod:`subprocess` module can now use the :func:`os.posix_spawn` function
819 in some cases for better performance. Currently, it is only used on macOS
820 and Linux (using glibc 2.24 or newer) if all these conditions are met:
821
822 * *close_fds* is false;
Victor Stinnerf6243ac2019-01-23 19:00:39 +0100823 * *preexec_fn*, *pass_fds*, *cwd* and *start_new_session* parameters
824 are not set;
Victor Stinner8c349562019-01-16 23:38:06 +0100825 * the *executable* path contains a directory.
Victor Stinner9daecf32019-01-16 00:02:35 +0100826
Victor Stinner01ae8972019-06-03 16:28:01 +0200827 (Contributed by Joannah Nanjekye and Victor Stinner in :issue:`35537`.)
828
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +0200829* :func:`shutil.copyfile`, :func:`shutil.copy`, :func:`shutil.copy2`,
830 :func:`shutil.copytree` and :func:`shutil.move` use platform-specific
Giampaolo Rodola413d9552019-05-30 14:05:41 +0800831 "fast-copy" syscalls on Linux and macOS in order to copy the file
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -0700832 more efficiently.
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +0200833 "fast-copy" means that the copying operation occurs within the kernel,
834 avoiding the use of userspace buffers in Python as in
835 "``outfd.write(infd.read())``".
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -0700836 On Windows :func:`shutil.copyfile` uses a bigger default buffer size (1 MiB
837 instead of 16 KiB) and a :func:`memoryview`-based variant of
838 :func:`shutil.copyfileobj` is used.
839 The speedup for copying a 512 MiB file within the same partition is about
840 +26% on Linux, +50% on macOS and +40% on Windows. Also, much less CPU cycles
841 are consumed.
842 See :ref:`shutil-platform-dependent-efficient-copy-operations` section.
Mariatta16501b72018-12-06 21:59:42 -0800843 (Contributed by Giampaolo Rodola' in :issue:`33671`.)
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +0200844
Giampaolo Rodola19c46a42018-11-12 06:18:15 -0800845* :func:`shutil.copytree` uses :func:`os.scandir` function and all copy
846 functions depending from it use cached :func:`os.stat` values. The speedup
847 for copying a directory with 8000 files is around +9% on Linux, +20% on
848 Windows and +30% on a Windows SMB share. Also the number of :func:`os.stat`
849 syscalls is reduced by 38% making :func:`shutil.copytree` especially faster
850 on network filesystems. (Contributed by Giampaolo Rodola' in :issue:`33695`.)
851
Łukasz Langac51d8c92018-04-03 23:06:53 -0700852* The default protocol in the :mod:`pickle` module is now Protocol 4,
853 first introduced in Python 3.4. It offers better performance and smaller
854 size compared to Protocol 3 available since Python 3.0.
Ned Deily07a18922018-01-31 18:12:38 -0500855
INADA Naokid5c875b2018-07-11 17:42:49 +0900856* Removed one ``Py_ssize_t`` member from ``PyGC_Head``. All GC tracked
857 objects (e.g. tuple, list, dict) size is reduced 4 or 8 bytes.
858 (Contributed by Inada Naoki in :issue:`33597`)
859
Tal Einat54752532018-09-10 16:11:04 +0300860* :class:`uuid.UUID` now uses ``__slots__`` to reduce its memory footprint.
Tal Einat54752532018-09-10 16:11:04 +0300861
Raymond Hettinger63fa1cf2019-02-16 12:02:22 -0800862* Improved performance of :func:`operator.itemgetter` by 33%. Optimized
863 argument handling and added a fast path for the common case of a single
864 non-negative integer index into a tuple (which is the typical use case in
865 the standard library). (Contributed by Raymond Hettinger in
866 :issue:`35664`.)
867
868* Sped-up field lookups in :func:`collections.namedtuple`. They are now more
869 than two times faster, making them the fastest form of instance variable
870 lookup in Python. (Contributed by Raymond Hettinger, Pablo Galindo, and
Joe Jevnikf36f8922019-02-21 16:00:40 -0500871 Joe Jevnik, Serhiy Storchaka in :issue:`32492`.)
Raymond Hettinger63fa1cf2019-02-16 12:02:22 -0800872
Pablo Galindoc61e2292018-10-28 22:03:18 +0000873* The :class:`list` constructor does not overallocate the internal item buffer
874 if the input iterable has a known length (the input implements ``__len__``).
Raymond Hettingere1823182019-02-16 12:47:48 -0800875 This makes the created list 12% smaller on average. (Contributed by
876 Raymond Hettinger and Pablo Galindo in :issue:`33234`.)
Pablo Galindoc61e2292018-10-28 22:03:18 +0000877
Stefan Behneld8b9e1f2019-02-20 18:29:24 +0100878* Doubled the speed of class variable writes. When a non-dunder attribute
879 was updated, there was an unnecessary call to update slots.
880 (Contributed by Stefan Behnel, Pablo Galindo Salgado, Raymond Hettinger,
881 Neil Schemenauer, and Serhiy Storchaka in :issue:`36012`.)
882
Serhiy Storchaka31913912019-03-14 10:32:22 +0200883* Reduced an overhead of converting arguments passed to many builtin functions
884 and methods. This sped up calling some simple builtin functions and
885 methods up to 20--50%. (Contributed by Serhiy Storchaka in :issue:`23867`,
886 :issue:`35582` and :issue:`36127`.)
887
Inada Naoki91234a12019-06-03 21:30:58 +0900888* ``LOAD_GLOBAL`` instruction now uses new "per opcode cache" mechanism.
889 It is about 40% faster now. (Contributed by Yury Selivanov and Inada Naoki in
890 :issue:`26219`.)
891
Serhiy Storchakaceeef102018-06-15 11:09:43 +0300892
Ned Deily07a18922018-01-31 18:12:38 -0500893Build and C API Changes
894=======================
895
Victor Stinnerbf4ac2d2019-01-22 17:39:03 +0100896* The :c:func:`PyByteArray_Init` and :c:func:`PyByteArray_Fini` functions have
897 been removed. They did nothing since Python 2.7.4 and Python 3.2.0, were
898 excluded from the limited API (stable ABI), and were not documented.
899
Serhiy Storchakaceeef102018-06-15 11:09:43 +0300900* The result of :c:func:`PyExceptionClass_Name` is now of type
901 ``const char *`` rather of ``char *``.
902 (Contributed by Serhiy Storchaka in :issue:`33818`.)
Ned Deily07a18922018-01-31 18:12:38 -0500903
Antoine Pitrou961d54c2018-07-16 19:03:03 +0200904* The duality of ``Modules/Setup.dist`` and ``Modules/Setup`` has been
905 removed. Previously, when updating the CPython source tree, one had
906 to manually copy ``Modules/Setup.dist`` (inside the source tree) to
907 ``Modules/Setup`` (inside the build tree) in order to reflect any changes
908 upstream. This was of a small benefit to packagers at the expense of
909 a frequent annoyance to developers following CPython development, as
910 forgetting to copy the file could produce build failures.
911
912 Now the build system always reads from ``Modules/Setup`` inside the source
913 tree. People who want to customize that file are encouraged to maintain
914 their changes in a git fork of CPython or as patch files, as they would do
915 for any other change to the source tree.
916
917 (Contributed by Antoine Pitrou in :issue:`32430`.)
918
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +0200919* Functions that convert Python number to C integer like
920 :c:func:`PyLong_AsLong` and argument parsing functions like
921 :c:func:`PyArg_ParseTuple` with integer converting format units like ``'i'``
922 will now use the :meth:`~object.__index__` special method instead of
923 :meth:`~object.__int__`, if available. The deprecation warning will be
924 emitted for objects with the ``__int__()`` method but without the
925 ``__index__()`` method (like :class:`~decimal.Decimal` and
926 :class:`~fractions.Fraction`). :c:func:`PyNumber_Check` will now return
927 ``1`` for objects implementing ``__index__()``.
Serhiy Storchakabdbad712019-06-02 00:05:48 +0300928 :c:func:`PyNumber_Long`, :c:func:`PyNumber_Float` and
929 :c:func:`PyFloat_AsDouble` also now use the ``__index__()`` method if
930 available.
931 (Contributed by Serhiy Storchaka in :issue:`36048` and :issue:`20092`.)
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +0200932
Eddie Elizondo364f0b02019-03-27 07:52:18 -0400933* Heap-allocated type objects will now increase their reference count
934 in :c:func:`PyObject_Init` (and its parallel macro ``PyObject_INIT``)
935 instead of in :c:func:`PyType_GenericAlloc`. Types that modify instance
936 allocation or deallocation may need to be adjusted.
937 (Contributed by Eddie Elizondo in :issue:`35810`.)
938
Ned Deily07a18922018-01-31 18:12:38 -0500939
940Deprecated
941==========
942
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +0300943* Deprecated methods ``getchildren()`` and ``getiterator()`` in
944 the :mod:`~xml.etree.ElementTree` module emit now a
945 :exc:`DeprecationWarning` instead of :exc:`PendingDeprecationWarning`.
946 They will be removed in Python 3.9.
947 (Contributed by Serhiy Storchaka in :issue:`29209`.)
Ned Deily07a18922018-01-31 18:12:38 -0500948
Elvis Pranskevichus22d25082018-07-30 11:42:43 +0100949* Passing an object that is not an instance of
950 :class:`concurrent.futures.ThreadPoolExecutor` to
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700951 :meth:`asyncio.loop.set_default_executor()` is
Elvis Pranskevichus22d25082018-07-30 11:42:43 +0100952 deprecated and will be prohibited in Python 3.9.
953 (Contributed by Elvis Pranskevichus in :issue:`34075`.)
954
Berker Peksagef8861c2018-08-21 17:58:49 +0300955* The :meth:`__getitem__` methods of :class:`xml.dom.pulldom.DOMEventStream`,
956 :class:`wsgiref.util.FileWrapper` and :class:`fileinput.FileInput` have been
957 deprecated.
958
959 Implementations of these methods have been ignoring their *index* parameter,
960 and returning the next item instead.
961
962 (Contributed by Berker Peksag in :issue:`9372`.)
963
Raymond Hettingerf7b57df2019-03-18 09:53:56 -0700964* The :class:`typing.NamedTuple` class has deprecated the ``_field_types``
965 attribute in favor of the ``__annotations__`` attribute which has the same
966 information. (Contributed by Raymond Hettinger in :issue:`36320`.)
967
Serhiy Storchaka3f228112018-09-27 17:42:37 +0300968* :mod:`ast` classes ``Num``, ``Str``, ``Bytes``, ``NameConstant`` and
969 ``Ellipsis`` are considered deprecated and will be removed in future Python
970 versions. :class:`~ast.Constant` should be used instead.
971 (Contributed by Serhiy Storchaka in :issue:`32892`.)
972
Serhiy Storchakafec35c92018-10-27 08:00:41 +0300973* The following functions and methods are deprecated in the :mod:`gettext`
974 module: :func:`~gettext.lgettext`, :func:`~gettext.ldgettext`,
975 :func:`~gettext.lngettext` and :func:`~gettext.ldngettext`.
976 They return encoded bytes, and it's possible that you will get unexpected
977 Unicode-related exceptions if there are encoding problems with the
978 translated strings. It's much better to use alternatives which return
979 Unicode strings in Python 3. These functions have been broken for a long time.
980
981 Function :func:`~gettext.bind_textdomain_codeset`, methods
982 :meth:`~gettext.NullTranslations.output_charset` and
983 :meth:`~gettext.NullTranslations.set_output_charset`, and the *codeset*
984 parameter of functions :func:`~gettext.translation` and
985 :func:`~gettext.install` are also deprecated, since they are only used for
986 for the ``l*gettext()`` functions.
987
988 (Contributed by Serhiy Storchaka in :issue:`33710`.)
989
Dong-hee Na89669ff2019-01-17 21:14:45 +0900990* The :meth:`~threading.Thread.isAlive()` method of :class:`threading.Thread` has been deprecated.
991 (Contributed by Dong-hee Na in :issue:`35283`.)
Ned Deily07a18922018-01-31 18:12:38 -0500992
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +0200993* Many builtin and extension functions that take integer arguments will
994 now emit a deprecation warning for :class:`~decimal.Decimal`\ s,
995 :class:`~fractions.Fraction`\ s and any other objects that can be converted
996 to integers only with a loss (e.g. that have the :meth:`~object.__int__`
997 method but do not have the :meth:`~object.__index__` method). In future
998 version they will be errors.
999 (Contributed by Serhiy Storchaka in :issue:`36048`.)
1000
Serhiy Storchaka42a139e2019-04-01 09:16:35 +03001001* Deprecated passing the following arguments as keyword arguments:
1002
1003 - *func* in :func:`functools.partialmethod`, :func:`weakref.finalize`,
1004 :meth:`profile.Profile.runcall`, :meth:`cProfile.Profile.runcall`,
1005 :meth:`bdb.Bdb.runcall`, :meth:`trace.Trace.runfunc` and
1006 :func:`curses.wrapper`.
Serhiy Storchaka2085bd02019-06-01 11:00:15 +03001007 - *function* in :meth:`unittest.TestCase.addCleanup`.
Serhiy Storchaka42a139e2019-04-01 09:16:35 +03001008 - *fn* in the :meth:`~concurrent.futures.Executor.submit` method of
1009 :class:`concurrent.futures.ThreadPoolExecutor` and
1010 :class:`concurrent.futures.ProcessPoolExecutor`.
1011 - *callback* in :meth:`contextlib.ExitStack.callback`,
1012 :meth:`contextlib.AsyncExitStack.callback` and
1013 :meth:`contextlib.AsyncExitStack.push_async_callback`.
1014 - *c* and *typeid* in the :meth:`~multiprocessing.managers.Server.create`
1015 method of :class:`multiprocessing.managers.Server` and
1016 :class:`multiprocessing.managers.SharedMemoryServer`.
1017 - *obj* in :func:`weakref.finalize`.
1018
1019 In future releases of Python they will be :ref:`positional-only
1020 <positional-only_parameter>`.
1021 (Contributed by Serhiy Storchaka in :issue:`36492`.)
1022
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001023
Victor Stinner73104fa2018-11-29 09:58:20 +01001024API and Feature Removals
1025========================
1026
1027The following features and APIs have been removed from Python 3.8:
1028
Victor Stinnerd7538dd2018-12-14 13:37:26 +01001029* The :mod:`macpath` module, deprecated in Python 3.7, has been removed.
1030 (Contributed by Victor Stinner in :issue:`35471`.)
1031
Victor Stinner73104fa2018-11-29 09:58:20 +01001032* The function :func:`platform.popen` has been removed, it was deprecated since
1033 Python 3.3: use :func:`os.popen` instead.
Victor Stinner01ae8972019-06-03 16:28:01 +02001034 (Contributed by Victor Stinner in :issue:`35345`.)
Ned Deily07a18922018-01-31 18:12:38 -05001035
Matthias Bussonnierb6a09ae2019-05-13 12:23:07 -07001036* The function :func:`time.clock` has been removed, it was deprecated since Python
1037 3.3: use :func:`time.perf_counter` or :func:`time.process_time` instead, depending
1038 on your requirements, to have a well defined behavior.
Victor Stinner01ae8972019-06-03 16:28:01 +02001039 (Contributed by Matthias Bussonnier in :issue:`36895`.)
Matthias Bussonnierb6a09ae2019-05-13 12:23:07 -07001040
Brett Cannona8c34242018-04-20 14:15:40 -07001041* The ``pyvenv`` script has been removed in favor of ``python3.8 -m venv``
1042 to help eliminate confusion as to what Python interpreter the ``pyvenv``
1043 script is tied to. (Contributed by Brett Cannon in :issue:`25427`.)
Ned Deily07a18922018-01-31 18:12:38 -05001044
INADA Naoki698865d2018-06-19 17:28:50 +09001045* ``parse_qs``, ``parse_qsl``, and ``escape`` are removed from :mod:`cgi`
1046 module. They are deprecated from Python 3.2 or older.
1047
INADA Naoki461a1c42018-06-28 17:10:36 +09001048* ``filemode`` function is removed from :mod:`tarfile` module.
1049 It is not documented and deprecated since Python 3.3.
INADA Naoki698865d2018-06-19 17:28:50 +09001050
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001051* The :class:`~xml.etree.ElementTree.XMLParser` constructor no longer accepts
1052 the *html* argument. It never had effect and was deprecated in Python 3.4.
1053 All other parameters are now :ref:`keyword-only <keyword-only_parameter>`.
1054 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1055
1056* Removed the ``doctype()`` method of :class:`~xml.etree.ElementTree.XMLParser`.
1057 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1058
Inada Naoki6a16b182019-03-18 15:44:11 +09001059* "unicode_internal" codec is removed.
1060 (Contributed by Inada Naoki in :issue:`36297`.)
1061
Aviv Palivodae6576242019-05-09 21:05:45 +03001062* The ``Cache`` and ``Statement`` objects of the :mod:`sqlite3` module are not
1063 exposed to the user.
1064 (Contributed by Aviv Palivoda in :issue:`30262`.)
1065
Matthias Bussonnier1a3faf92019-05-20 13:44:11 -07001066* The ``bufsize`` keyword argument of :func:`fileinput.input` and
1067 :func:`fileinput.FileInput` which was ignored and deprecated since Python 3.6
1068 has been removed. :issue:`36952` (Contributed by Matthias Bussonnier)
1069
Matthias Bussonnier382034b2019-05-28 10:30:35 -07001070* The functions :func:`sys.set_coroutine_wrapper` and
1071 :func:`sys.get_coroutine_wrapper` deprecated in Python 3.7 have been removed;
1072 :issue:`36933` (Contributed by Matthias Bussonnier)
Matthias Bussonnier3880f262019-05-28 00:10:59 -07001073
Ned Deily07a18922018-01-31 18:12:38 -05001074
1075Porting to Python 3.8
1076=====================
1077
1078This section lists previously described changes and other bugfixes
1079that may require changes to your code.
1080
1081
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001082Changes in Python behavior
1083--------------------------
1084
1085* Yield expressions (both ``yield`` and ``yield from`` clauses) are now disallowed
1086 in comprehensions and generator expressions (aside from the iterable expression
Serhiy Storchaka2b57c432018-12-19 08:09:46 +02001087 in the leftmost :keyword:`!for` clause).
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001088 (Contributed by Serhiy Storchaka in :issue:`10544`.)
1089
Serhiy Storchaka3bcbedc2019-01-18 07:47:48 +02001090* The compiler now produces a :exc:`SyntaxWarning` when identity checks
1091 (``is`` and ``is not``) are used with certain types of literals
1092 (e.g. strings, ints). These can often work by accident in CPython,
1093 but are not guaranteed by the language spec. The warning advises users
1094 to use equality tests (``==`` and ``!=``) instead.
1095 (Contributed by Serhiy Storchaka in :issue:`34850`.)
1096
Serhiy Storchaka7a0630c2019-04-08 14:34:04 +03001097* The CPython interpreter can swallow exceptions in some circumstances.
1098 In Python 3.8 this happens in less cases. In particular, exceptions
1099 raised when getting the attribute from the type dictionary are no longer
1100 ignored. (Contributed by Serhiy Storchaka in :issue:`35459`.)
1101
Serhiy Storchaka96aeaec2019-05-06 22:29:40 +03001102* Removed ``__str__`` implementations from builtin types :class:`bool`,
1103 :class:`int`, :class:`float`, :class:`complex` and few classes from
1104 the standard library. They now inherit ``__str__()`` from :class:`object`.
1105 As result, defining the ``__repr__()`` method in the subclass of these
1106 classes will affect they string representation.
1107 (Contributed by Serhiy Storchaka in :issue:`36793`.)
1108
Michael Felt9d949f72019-04-12 16:15:32 +02001109* On AIX, :attr:`sys.platform` doesn't contain the major version anymore.
1110 It is always ``'aix'``, instead of ``'aix3'`` .. ``'aix7'``. Since
1111 older Python versions include the version number, it is recommended to
1112 always use the ``sys.platform.startswith('aix')``.
1113 (Contributed by M. Felt in :issue:`36588`.)
Serhiy Storchaka07ca9af2018-02-04 10:53:48 +02001114
Joannah Nanjekyef781d202019-04-29 04:38:45 -04001115* :c:func:`PyEval_AcquireLock` and :c:func:`PyEval_AcquireThread` now
1116 terminate the current thread if called while the interpreter is
1117 finalizing, making them consistent with :c:func:`PyEval_RestoreThread`,
1118 :c:func:`Py_END_ALLOW_THREADS`, and :c:func:`PyGILState_Ensure`. If this
1119 behaviour is not desired, guard the call by checking :c:func:`_Py_IsFinalizing`
1120 or :c:func:`sys.is_finalizing`.
1121
Serhiy Storchaka97f1ca12018-02-01 18:49:21 +02001122Changes in the Python API
1123-------------------------
1124
Victor Stinnerd7befad2019-04-25 14:30:16 +02001125* :class:`subprocess.Popen` can now use :func:`os.posix_spawn` in some cases
1126 for better performance. On Windows Subsystem for Linux and QEMU User
1127 Emulation, Popen constructor using :func:`os.posix_spawn` no longer raise an
1128 exception on errors like missing program, but the child process fails with a
1129 non-zero :attr:`~Popen.returncode`.
Victor Stinner01ae8972019-06-03 16:28:01 +02001130 (Contributed by Joannah Nanjekye and Victor Stinner in :issue:`35537`.)
Victor Stinnerd7befad2019-04-25 14:30:16 +02001131
Victor Stinner74125a62019-04-15 18:23:20 +02001132* The :meth:`imap.IMAP4.logout` method no longer ignores silently arbitrary
1133 exceptions.
1134
Victor Stinner73104fa2018-11-29 09:58:20 +01001135* The function :func:`platform.popen` has been removed, it was deprecated since
1136 Python 3.3: use :func:`os.popen` instead.
Victor Stinner01ae8972019-06-03 16:28:01 +02001137 (Contributed by Victor Stinner in :issue:`35345`.)
Victor Stinner73104fa2018-11-29 09:58:20 +01001138
Raymond Hettingerfc06a192019-03-12 00:43:27 -07001139* The :func:`statistics.mode` function no longer raises an exception
1140 when given multimodal data. Instead, it returns the first mode
1141 encountered in the input data. (Contributed by Raymond Hettinger
1142 in :issue:`35892`.)
1143
Serhiy Storchaka97f1ca12018-02-01 18:49:21 +02001144* The :meth:`~tkinter.ttk.Treeview.selection` method of the
1145 :class:`tkinter.ttk.Treeview` class no longer takes arguments. Using it with
1146 arguments for changing the selection was deprecated in Python 3.6. Use
1147 specialized methods like :meth:`~tkinter.ttk.Treeview.selection_set` for
1148 changing the selection. (Contributed by Serhiy Storchaka in :issue:`31508`.)
Serhiy Storchaka6c85efa52018-02-05 22:47:31 +02001149
Diego Rojas06e1e682019-03-16 18:44:56 -05001150* The :meth:`writexml`, :meth:`toxml` and :meth:`toprettyxml` methods of the
1151 :mod:`xml.dom.minidom` module, and :mod:`xml.etree` now preserve the attribute
1152 order specified by the user.
1153 (Contributed by Diego Rojas and Raymond Hettinger in :issue:`34160`.)
1154
Serhiy Storchaka6c85efa52018-02-05 22:47:31 +02001155* A :mod:`dbm.dumb` database opened with flags ``'r'`` is now read-only.
1156 :func:`dbm.dumb.open` with flags ``'r'`` and ``'w'`` no longer creates
1157 a database if it does not exist.
1158 (Contributed by Serhiy Storchaka in :issue:`32749`.)
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001159
Serhiy Storchaka02ec92f2018-07-24 12:03:34 +03001160* The ``doctype()`` method defined in a subclass of
1161 :class:`~xml.etree.ElementTree.XMLParser` will no longer be called and will
1162 cause emitting a :exc:`RuntimeWarning` instead of a :exc:`DeprecationWarning`.
1163 Define the :meth:`doctype() <xml.etree.ElementTree.TreeBuilder.doctype>`
1164 method on a target for handling an XML doctype declaration.
1165 (Contributed by Serhiy Storchaka in :issue:`29209`.)
1166
Serhiy Storchakaf5e7b192018-05-20 08:48:12 +03001167* A :exc:`RuntimeError` is now raised when the custom metaclass doesn't
1168 provide the ``__classcell__`` entry in the namespace passed to
1169 ``type.__new__``. A :exc:`DeprecationWarning` was emitted in Python
1170 3.6--3.7. (Contributed by Serhiy Storchaka in :issue:`23722`.)
1171
Scott Sandersoncebe80b2018-06-07 05:46:42 -04001172* The :class:`cProfile.Profile` class can now be used as a context
1173 manager. (Contributed by Scott Sanderson in :issue:`29235`.)
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001174
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07001175* :func:`shutil.copyfile`, :func:`shutil.copy`, :func:`shutil.copy2`,
1176 :func:`shutil.copytree` and :func:`shutil.move` use platform-specific
1177 "fast-copy" syscalls (see
1178 :ref:`shutil-platform-dependent-efficient-copy-operations` section).
1179
1180* :func:`shutil.copyfile` default buffer size on Windows was changed from
1181 16 KiB to 1 MiB.
1182
INADA Naokid5c875b2018-07-11 17:42:49 +09001183* ``PyGC_Head`` struct is changed completely. All code touched the
1184 struct member should be rewritten. (See :issue:`33597`)
1185
Eric Snowbe3b2952019-02-23 11:35:52 -07001186* The ``PyInterpreterState`` struct has been moved into the "internal"
1187 header files (specifically Include/internal/pycore_pystate.h). An
1188 opaque ``PyInterpreterState`` is still available as part of the public
1189 API (and stable ABI). The docs indicate that none of the struct's
1190 fields are public, so we hope no one has been using them. However,
1191 if you do rely on one or more of those private fields and have no
1192 alternative then please open a BPO issue. We'll work on helping
1193 you adjust (possibly including adding accessor functions to the
1194 public API). (See :issue:`35886`.)
1195
Alex Grönholmcca4eec2018-08-09 00:06:47 +03001196* Asyncio tasks can now be named, either by passing the ``name`` keyword
1197 argument to :func:`asyncio.create_task` or
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001198 the :meth:`~asyncio.loop.create_task` event loop method, or by
Alex Grönholmcca4eec2018-08-09 00:06:47 +03001199 calling the :meth:`~asyncio.Task.set_name` method on the task object. The
1200 task name is visible in the ``repr()`` output of :class:`asyncio.Task` and
1201 can also be retrieved using the :meth:`~asyncio.Task.get_name` method.
1202
Berker Peksage7d4b2f2018-08-22 21:21:05 +03001203* The :meth:`mmap.flush() <mmap.mmap.flush>` method now returns ``None`` on
1204 success and raises an exception on error under all platforms. Previously,
1205 its behavior was platform-depended: a nonzero value was returned on success;
1206 zero was returned on error under Windows. A zero value was returned on
1207 success; an exception was raised on error under Unix.
1208 (Contributed by Berker Peksag in :issue:`2122`.)
1209
Andrés Delfinoca682612018-11-07 14:29:14 -03001210* :mod:`xml.dom.minidom` and :mod:`xml.sax` modules no longer process
Christian Heimes17b1d5d2018-09-23 09:50:25 +02001211 external entities by default.
1212 (Contributed by Christian Heimes in :issue:`17239`.)
INADA Naokid5c875b2018-07-11 17:42:49 +09001213
Xiang Zhang4fb0b8b2018-12-12 20:46:55 +08001214* Deleting a key from a read-only :mod:`dbm` database (:mod:`dbm.dumb`,
1215 :mod:`dbm.gnu` or :mod:`dbm.ndbm`) raises :attr:`error` (:exc:`dbm.dumb.error`,
1216 :exc:`dbm.gnu.error` or :exc:`dbm.ndbm.error`) instead of :exc:`KeyError`.
1217 (Contributed by Xiang Zhang in :issue:`33106`.)
1218
Steve Dower8ef864d2019-03-12 15:15:26 -07001219* :func:`~os.path.expanduser` on Windows now prefers the :envvar:`USERPROFILE`
1220 environment variable and does not use :envvar:`HOME`, which is not normally
1221 set for regular user accounts.
1222
Steve Dower2438cdf2019-03-29 16:37:16 -07001223.. _bpo-36085-whatsnew:
1224
1225* DLL dependencies for extension modules and DLLs loaded with :mod:`ctypes` on
1226 Windows are now resolved more securely. Only the system paths, the directory
1227 containing the DLL or PYD file, and directories added with
1228 :func:`~os.add_dll_directory` are searched for load-time dependencies.
1229 Specifically, :envvar:`PATH` and the current working directory are no longer
1230 used, and modifications to these will no longer have any effect on normal DLL
1231 resolution. If your application relies on these mechanisms, you should check
1232 for :func:`~os.add_dll_directory` and if it exists, use it to add your DLLs
Steve Dower79da3882019-03-30 20:58:17 -07001233 directory while loading your library. Note that Windows 7 users will need to
1234 ensure that Windows Update KB2533625 has been installed (this is also verified
1235 by the installer).
Steve Dower2438cdf2019-03-29 16:37:16 -07001236 (See :issue:`36085`.)
1237
Pablo Galindof2cf1e32019-04-13 17:05:14 +01001238* The header files and functions related to pgen have been removed after its
1239 replacement by a pure Python implementation. (Contributed by Pablo Galindo
1240 in :issue:`36623`.)
1241
Pablo Galindo5d23e282019-05-12 22:45:52 +01001242* :class:`types.CodeType` has a new parameter in the second position of the
1243 constructor (*posonlyargcount*) to support positional-only arguments defined
Pablo Galindocd74e662019-06-01 18:08:04 +01001244 in :pep:`570`. The first argument (*argcount*) now represents the total
1245 number of positional arguments (including positional-only arguments). A new
1246 ``replace()`` method of :class:`types.CodeType` can be used to make the code
1247 future-proof.
Pablo Galindo5d23e282019-05-12 22:45:52 +01001248
Xiang Zhang4fb0b8b2018-12-12 20:46:55 +08001249
Inada Naokid3c72a22019-03-23 21:04:40 +09001250Changes in the C API
1251--------------------
1252
Victor Stinnerd5d9e812019-05-13 12:35:37 +02001253* The :c:func:`PyEval_ReInitThreads` function has been removed from the C API.
1254 It should not be called explicitly: use :c:func:`PyOS_AfterFork_Child`
1255 instead.
1256 (Contributed by Victor Stinner in :issue:`36728`.)
1257
E. M. Brayc994c8f2019-05-24 17:33:47 +02001258* On Unix, C extensions are no longer linked to libpython except on Android
1259 and Cygwin. When Python is embedded, ``libpython`` must not be loaded with
xdegaye254b3092019-04-29 09:27:40 +02001260 ``RTLD_LOCAL``, but ``RTLD_GLOBAL`` instead. Previously, using
E. M. Brayc994c8f2019-05-24 17:33:47 +02001261 ``RTLD_LOCAL``, it was already not possible to load C extensions which
1262 were not linked to ``libpython``, like C extensions of the standard
1263 library built by the ``*shared*`` section of ``Modules/Setup``.
Victor Stinner01ae8972019-06-03 16:28:01 +02001264 (Contributed by Victor Stinner in :issue:`21536`.)
Victor Stinner8c3ecc62019-04-25 20:13:10 +02001265
Inada Naokid3c72a22019-03-23 21:04:40 +09001266* Use of ``#`` variants of formats in parsing or building value (e.g.
1267 :c:func:`PyArg_ParseTuple`, :c:func:`Py_BuildValue`, :c:func:`PyObject_CallFunction`,
1268 etc.) without ``PY_SSIZE_T_CLEAN`` defined raises ``DeprecationWarning`` now.
1269 It will be removed in 3.10 or 4.0. Read :ref:`arg-parsing` for detail.
1270 (Contributed by Inada Naoki in :issue:`36381`.)
1271
Eddie Elizondo364f0b02019-03-27 07:52:18 -04001272* Instances of heap-allocated types (such as those created with
1273 :c:func:`PyType_FromSpec`) hold a reference to their type object.
1274 Increasing the reference count of these type objects has been moved from
1275 :c:func:`PyType_GenericAlloc` to the more low-level functions,
1276 :c:func:`PyObject_Init` and :c:func:`PyObject_INIT`.
1277 This makes types created through :c:func:`PyType_FromSpec` behave like
1278 other classes in managed code.
1279
1280 Statically allocated types are not affected.
1281
1282 For the vast majority of cases, there should be no side effect.
1283 However, types that manually increase the reference count after allocating
1284 an instance (perhaps to work around the bug) may now become immortal.
1285 To avoid this, these classes need to call Py_DECREF on the type object
1286 during instance deallocation.
1287
1288 To correctly port these types into 3.8, please apply the following
1289 changes:
1290
1291 * Remove :c:macro:`Py_INCREF` on the type object after allocating an
1292 instance - if any.
1293 This may happen after calling :c:func:`PyObject_New`,
1294 :c:func:`PyObject_NewVar`, :c:func:`PyObject_GC_New`,
1295 :c:func:`PyObject_GC_NewVar`, or any other custom allocator that uses
1296 :c:func:`PyObject_Init` or :c:func:`PyObject_INIT`.
1297
1298 Example::
1299
1300 static foo_struct *
1301 foo_new(PyObject *type) {
1302 foo_struct *foo = PyObject_GC_New(foo_struct, (PyTypeObject *) type);
1303 if (foo == NULL)
1304 return NULL;
1305 #if PY_VERSION_HEX < 0x03080000
1306 // Workaround for Python issue 35810; no longer necessary in Python 3.8
1307 PY_INCREF(type)
1308 #endif
1309 return foo;
1310 }
1311
1312 * Ensure that all custom ``tp_dealloc`` functions of heap-allocated types
1313 decrease the type's reference count.
1314
1315 Example::
1316
1317 static void
1318 foo_dealloc(foo_struct *instance) {
1319 PyObject *type = Py_TYPE(instance);
1320 PyObject_GC_Del(instance);
1321 #if PY_VERSION_HEX >= 0x03080000
1322 // This was not needed before Python 3.8 (Python issue 35810)
1323 Py_DECREF(type);
1324 #endif
1325 }
1326
1327 (Contributed by Eddie Elizondo in :issue:`35810`.)
1328
Zackery Spytz3c8724f2019-05-28 09:16:33 -06001329* The :c:macro:`Py_DEPRECATED()` macro has been implemented for MSVC.
1330 The macro now must be placed before the symbol name.
1331
1332 Example::
1333
1334 Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);
1335
1336 (Contributed by Zackery Spytz in :issue:`33407`.)
1337
Antoine Pitrouada319b2019-05-29 22:12:38 +02001338* The interpreter does not pretend to support binary compatibility of
Xtreak0d702272019-06-03 04:42:33 +05301339 extension types across feature releases, anymore. A :c:type:`PyTypeObject`
Antoine Pitrouada319b2019-05-29 22:12:38 +02001340 exported by a third-party extension module is supposed to have all the
1341 slots expected in the current Python version, including
1342 :c:member:`~PyTypeObject.tp_finalize` (:const:`Py_TPFLAGS_HAVE_FINALIZE`
1343 is not checked anymore before reading :c:member:`~PyTypeObject.tp_finalize`).
1344
1345 (Contributed by Antoine Pitrou in :issue:`32388`.)
1346
Pablo Galindo545a3b82019-05-31 19:33:41 +01001347* The :c:func:`PyCode_New` has a new parameter in the second position (*posonlyargcount*)
1348 to support :pep:`570`, indicating the number of positional-only arguments.
1349
Eddie Elizondo364f0b02019-03-27 07:52:18 -04001350
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001351CPython bytecode changes
1352------------------------
1353
1354* The interpreter loop has been simplified by moving the logic of unrolling
1355 the stack of blocks into the compiler. The compiler emits now explicit
Serhiy Storchaka3f819ca2018-10-31 02:26:06 +02001356 instructions for adjusting the stack of values and calling the
1357 cleaning-up code for :keyword:`break`, :keyword:`continue` and
1358 :keyword:`return`.
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001359
1360 Removed opcodes :opcode:`BREAK_LOOP`, :opcode:`CONTINUE_LOOP`,
1361 :opcode:`SETUP_LOOP` and :opcode:`SETUP_EXCEPT`. Added new opcodes
1362 :opcode:`ROT_FOUR`, :opcode:`BEGIN_FINALLY`, :opcode:`CALL_FINALLY` and
1363 :opcode:`POP_FINALLY`. Changed the behavior of :opcode:`END_FINALLY`
1364 and :opcode:`WITH_CLEANUP_START`.
1365
1366 (Contributed by Mark Shannon, Antoine Pitrou and Serhiy Storchaka in
1367 :issue:`17611`.)
Serhiy Storchaka702f8f32018-03-23 14:34:35 +02001368
1369* Added new opcode :opcode:`END_ASYNC_FOR` for handling exceptions raised
1370 when awaiting a next item in an :keyword:`async for` loop.
1371 (Contributed by Serhiy Storchaka in :issue:`33041`.)
Raymond Hettingerf75d59e2019-02-02 22:54:56 -08001372
1373
1374Demos and Tools
1375---------------
1376
1377* Added a benchmark script for timing various ways to access variables:
1378 ``Tools/scripts/var_access_benchmark.py``.
1379 (Contributed by Raymond Hettinger in :issue:`35884`.)