blob: be529d75e13c05e67247ec06e0b4a60a54196d20 [file] [log] [blame]
Pablo Galindod4fe0982020-05-19 03:33:01 +01001****************************
2 What's New In Python 3.10
3****************************
4
5:Release: |release|
6:Date: |today|
7
8.. Rules for maintenance:
9
10 * Anyone can add text to this document. Do not spend very much time
11 on the wording of your changes, because your text will probably
12 get rewritten to some degree.
13
14 * The maintainer will go through Misc/NEWS periodically and add
15 changes; it's therefore more important to add your changes to
16 Misc/NEWS than to this file.
17
18 * This is not a complete list of every single change; completeness
19 is the purpose of Misc/NEWS. Some changes I consider too small
20 or esoteric to include. If such a change is added to the text,
21 I'll just remove it. (This is another reason you shouldn't spend
22 too much time on writing your addition.)
23
24 * If you want to draw your new text to the attention of the
25 maintainer, add 'XXX' to the beginning of the paragraph or
26 section.
27
28 * It's OK to just add a fragmentary note about a change. For
29 example: "XXX Describe the transmogrify() function added to the
30 socket module." The maintainer will research the change and
31 write the necessary text.
32
33 * You can comment out your additions if you like, but it's not
34 necessary (especially when a final release is some months away).
35
36 * Credit the author of a patch or bugfix. Just the name is
37 sufficient; the e-mail address isn't necessary.
38
39 * It's helpful to add the bug/patch number as a comment:
40
41 XXX Describe the transmogrify() function added to the socket
42 module.
43 (Contributed by P.Y. Developer in :issue:`12345`.)
44
45 This saves the maintainer the effort of going through the Mercurial log
46 when researching a change.
47
48This article explains the new features in Python 3.10, compared to 3.9.
49
Ned Deily29251b72020-05-19 07:39:29 -040050For full details, see the :ref:`changelog <changelog>`.
Pablo Galindod4fe0982020-05-19 03:33:01 +010051
52.. note::
53
54 Prerelease users should be aware that this document is currently in draft
55 form. It will be updated substantially as Python 3.10 moves towards release,
56 so it's worth checking back even after reading earlier versions.
57
58
59Summary -- Release highlights
60=============================
61
62.. This section singles out the most important changes in Python 3.10.
63 Brevity is key.
64
65
66.. PEP-sized items next.
67
68
69
70New Features
71============
72
Batuhan Taskaya044a1042020-10-06 23:03:02 +030073.. _whatsnew310-pep563:
74
75PEP 563: Postponed Evaluation of Annotations Becomes Default
76------------------------------------------------------------
77
78In Python 3.7, postponed evaluation of annotations was added,
79to be enabled with a ``from __future__ import annotations``
80directive. In 3.10 this became the default behavior, even
81without that future directive. With this being default, all
82annotations stored in :attr:`__annotations__` will be strings.
83If needed, annotations can be resolved at runtime using
84:func:`typing.get_type_hints`. See :pep:`563` for a full
85description. Also, the :func:`inspect.signature` will try to
86resolve types from now on, and when it fails it will fall back to
87showing the string annotations. (Contributed by Batuhan Taskaya
88in :issue:`38605`.)
89
Niklas Fiekas8bd216d2020-05-29 18:28:02 +020090* The :class:`int` type has a new method :meth:`int.bit_count`, returning the
91 number of ones in the binary expansion of a given integer, also known
92 as the population count. (Contributed by Niklas Fiekas in :issue:`29882`.)
Pablo Galindod4fe0982020-05-19 03:33:01 +010093
Dennis Sweeney3ee0e482020-06-12 13:19:25 -040094* The views returned by :meth:`dict.keys`, :meth:`dict.values` and
95 :meth:`dict.items` now all have a ``mapping`` attribute that gives a
96 :class:`types.MappingProxyType` object wrapping the original
97 dictionary. (Contributed by Dennis Sweeney in :issue:`40890`.)
98
Ram Rachum59cf8532020-06-19 23:39:22 +030099* :pep:`618`: The :func:`zip` function now has an optional ``strict`` flag, used
100 to require that all the iterables have an equal length.
101
Mikhail Golubev4f3c2502020-10-08 00:44:31 +0300102PEP 613: TypeAlias Annotation
103-----------------------------
104
105:pep:`484` introduced the concept of type aliases, only requiring them to be
106top-level unannotated assignments. This simplicity sometimes made it difficult
107for type checkers to distinguish between type aliases and ordinary assignments,
108especially when forward references or invalid types were involved. Compare::
109
110 StrCache = 'Cache[str]' # a type alias
111 LOG_PREFIX = 'LOG[DEBUG]' # a module constant
112
113Now the :mod:`typing` module has a special annotation :data:`TypeAlias` to
114declare type aliases more explicitly::
115
116 StrCache: TypeAlias = 'Cache[str]' # a type alias
117 LOG_PREFIX = 'LOG[DEBUG]' # a module constant
118
119See :pep:`613` for more details.
120
121(Contributed by Mikhail Golubev in :issue:`41923`.)
122
kj8d17d2b2020-11-25 11:59:59 +0700123PEP 604: New Type Union Operator
124--------------------------------
Fidget-Spinner8e1dd552020-10-05 12:40:52 +0800125
126A new type union operator was introduced which enables the syntax ``X | Y``.
127This provides a cleaner way of expressing 'either type X or type Y' instead of
128using :data:`typing.Union`, especially in type hints (annotations).
129
130In previous versions of Python, to apply a type hint for functions accepting
131arguments of multiple types, :data:`typing.Union` was used::
132
133 def square(number: Union[int, float]) -> Union[int, float]:
134 return number ** 2
135
136
kjd21cb2d2020-10-31 23:08:17 +0800137Type hints can now be written in a more succinct manner::
Fidget-Spinner8e1dd552020-10-05 12:40:52 +0800138
139 def square(number: int | float) -> int | float:
140 return number ** 2
141
142
143See :pep:`604` for more details.
144
145(Contributed by Maggie Moss and Philippe Prados in :issue:`41428`.)
Pablo Galindod4fe0982020-05-19 03:33:01 +0100146
Ken Jin11276cd2021-01-02 08:45:50 +0800147PEP 612: Parameter Specification Variables
148------------------------------------------
149
150Two new options to improve the information provided to static type checkers for
151:pep:`484`\ 's ``Callable`` have been added to the :mod:`typing` module.
152
153The first is the parameter specification variable. They are used to forward the
154parameter types of one callable to another callable -- a pattern commonly
155found in higher order functions and decorators. Examples of usage can be found
156in :class:`typing.ParamSpec`. Previously, there was no easy way to type annotate
157dependency of parameter types in such a precise manner.
158
159The second option is the new ``Concatenate`` operator. It's used in conjunction
160with parameter specification variables to type annotate a higher order callable
161which adds or removes parameters of another callable. Examples of usage can
162be found in :class:`typing.Concatenate`.
163
164See :class:`typing.Callable`, :class:`typing.ParamSpec`,
165:class:`typing.Concatenate` and :pep:`612` for more details.
166
167(Contributed by Ken Jin in :issue:`41559`.)
168
Pablo Galindod4fe0982020-05-19 03:33:01 +0100169Other Language Changes
170======================
171
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300172* Builtin and extension functions that take integer arguments no longer accept
173 :class:`~decimal.Decimal`\ s, :class:`~fractions.Fraction`\ s and other
174 objects that can be converted to integers only with a loss (e.g. that have
175 the :meth:`~object.__int__` method but do not have the
176 :meth:`~object.__index__` method).
177 (Contributed by Serhiy Storchaka in :issue:`37999`.)
Pablo Galindod4fe0982020-05-19 03:33:01 +0100178
Lysandros Nikolaoua85fefe2020-11-19 01:49:28 +0200179* Assignment expressions can now be used unparenthesized within set literals
180 and set comprehensions, as well as in sequence indexes (but not slices).
181
Pablo Galindod4fe0982020-05-19 03:33:01 +0100182
183New Modules
184===========
185
186* None yet.
187
188
189Improved Modules
190================
191
Filipe LaĆ­ns4ce6faa2020-08-10 15:48:20 +0100192base64
193------
194
195Add :func:`base64.b32hexencode` and :func:`base64.b32hexdecode` to support the
196Base32 Encoding with Extended Hex Alphabet.
197
Hai Shid332e7b2020-09-29 05:41:11 +0800198codecs
199------
200
201Add a :func:`codecs.unregister` function to unregister a codec search function.
202(Contributed by Hai Shi in :issue:`41842`.)
203
kjd75f6f72020-12-19 01:39:26 +0800204collections.abc
205---------------
206
207The ``__args__`` of the :ref:`parameterized generic <types-genericalias>` for
208:class:`collections.abc.Callable` are now consistent with :data:`typing.Callable`.
209:class:`collections.abc.Callable` generic now flattens type parameters, similar
210to what :data:`typing.Callable` currently does. This means that
211``collections.abc.Callable[[int, str], str]`` will have ``__args__`` of
212``(int, str, str)``; previously this was ``([int, str], str)``. To allow this
213change, :class:`types.GenericAlias` can now be subclassed, and a subclass will
214be returned when subscripting the :class:`collections.abc.Callable` type. Note
215that a :exc:`TypeError` may be raised for invalid forms of parameterizing
216:class:`collections.abc.Callable` which may have passed silently in Python 3.9.
217(Contributed by Ken Jin in :issue:`42195`.)
218
Joongi Kim3eb28462020-11-11 00:19:11 +0900219contextlib
220----------
221
222Add a :func:`contextlib.aclosing` context manager to safely close async generators
223and objects representing asynchronously released resources.
224(Contributed by Joongi Kim and John Belmonte in :issue:`41229`.)
225
Tom Gringauz9c98e8c2020-11-18 00:58:35 +0200226Add asynchronous context manager support to :func:`contextlib.nullcontext`.
227(Contributed by Tom Gringauz in :issue:`41543`.)
228
Hans Petter Janssonda4e09f2020-08-03 22:51:33 -0500229curses
230------
231
232The extended color functions added in ncurses 6.1 will be used transparently
233by :func:`curses.color_content`, :func:`curses.init_color`,
234:func:`curses.init_pair`, and :func:`curses.pair_content`. A new function,
235:func:`curses.has_extended_color_support`, indicates whether extended color
236support is provided by the underlying ncurses library.
237(Contributed by Jeffrey Kintscher and Hans Petter Jansson in :issue:`36982`.)
238
Brett Cannon825ac382020-11-06 18:45:56 -0800239doctest
240-------
241
242When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
243(Contributed by Brett Cannon in :issue:`42133`.)
244
Hai Shic5b049b2020-10-14 23:43:31 +0800245encodings
246---------
247:func:`encodings.normalize_encoding` now ignores non-ASCII characters.
248(Contributed by Hai Shi in :issue:`39337`.)
249
Serhiy Storchaka8a64cea2020-06-18 22:08:27 +0300250glob
251----
252
253Added the *root_dir* and *dir_fd* parameters in :func:`~glob.glob` and
254:func:`~glob.iglob` which allow to specify the root directory for searching.
255(Contributed by Serhiy Storchaka in :issue:`38144`.)
256
Brett Cannon825ac382020-11-06 18:45:56 -0800257inspect
258-------
259
260When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
261(Contributed by Brett Cannon in :issue:`42133`.)
262
Batuhan Taskayaeee1c772020-12-24 01:45:13 +0300263Added *globalns* and *localns* parameters in :func:`~inspect.signature` and
264:meth:`inspect.Signature.from_callable` to retrieve the annotations in given
265local and global namespaces.
266(Contributed by Batuhan Taskaya in :issue:`41960`.)
267
Brett Cannon825ac382020-11-06 18:45:56 -0800268linecache
269---------
270
271When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
272(Contributed by Brett Cannon in :issue:`42133`.)
273
pxinwr3405e052020-08-07 13:21:52 +0800274os
275--
276
277Added :func:`os.cpu_count()` support for VxWorks RTOS.
278(Contributed by Peixing Xin in :issue:`41440`.)
279
Christian Heimescd9fed62020-11-13 19:48:52 +0100280Added a new function :func:`os.eventfd` and related helpers to wrap the
281``eventfd2`` syscall on Linux.
282(Contributed by Christian Heimes in :issue:`41001`.)
283
Pablo Galindoa57b3d32020-11-17 00:00:38 +0000284Added :func:`os.splice()` that allows to move data between two file
285descriptors without copying between kernel address space and user
286address space, where one of the file descriptors must refer to a
287pipe. (Contributed by Pablo Galindo in :issue:`41625`.)
288
Joshua Cannon45205842020-11-20 09:40:39 -0600289pathlib
290-------
291
Yaroslav Pankovych79d2e622020-11-23 22:06:22 +0200292Added slice support to :attr:`PurePath.parents <pathlib.PurePath.parents>`.
Joshua Cannon45205842020-11-20 09:40:39 -0600293(Contributed by Joshua Cannon in :issue:`35498`)
294
Yaroslav Pankovych79d2e622020-11-23 22:06:22 +0200295Added negative indexing support to :attr:`PurePath.parents
296<pathlib.PurePath.parents>`.
297(Contributed by Yaroslav Pankovych in :issue:`21041`)
298
Christian Heimes5c73afc2020-11-30 22:34:45 +0100299platform
300--------
301
302Added :func:`platform.freedesktop_os_release()` to retrieve operation system
303identification from `freedesktop.org os-release
304<https://www.freedesktop.org/software/systemd/man/os-release.html>`_ standard file.
305(Contributed by Christian Heimes in :issue:`28468`)
306
Gregory Schevchenkodaff3902020-07-25 22:58:45 +0300307py_compile
308----------
309
310Added ``--quiet`` option to command-line interface of :mod:`py_compile`.
311(Contributed by Gregory Schevchenko in :issue:`38731`.)
312
Zackery Spytzdf592732020-10-29 03:44:35 -0600313shelve
314------
315
316The :mod:`shelve` module now uses :data:`pickle.DEFAULT_PROTOCOL` by default
317instead of :mod:`pickle` protocol ``3`` when creating shelves.
318(Contributed by Zackery Spytz in :issue:`34204`.)
319
Brett Cannon825ac382020-11-06 18:45:56 -0800320site
321----
322
323When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
324(Contributed by Brett Cannon in :issue:`42133`.)
325
Christian Heimes03c8ddd2020-11-20 09:26:07 +0100326socket
327------
328
329The exception :exc:`socket.timeout` is now an alias of :exc:`TimeoutError`.
330(Contributed by Christian Heimes in :issue:`42413`.)
331
Victor Stinnerdd8a93e2020-06-30 00:49:03 +0200332sys
333---
334
335Add :data:`sys.orig_argv` attribute: the list of the original command line
336arguments passed to the Python executable.
337(Contributed by Victor Stinner in :issue:`23427`.)
338
Mario Corchero0001a1b2020-11-04 10:27:43 +0100339threading
340---------
341
342Added :func:`threading.gettrace` and :func:`threading.getprofile` to
343retrieve the functions set by :func:`threading.settrace` and
344:func:`threading.setprofile` respectively.
345(Contributed by Mario Corchero in :issue:`42251`.)
346
Mario Corchero750c5ab2020-11-12 18:27:44 +0100347Add :data:`threading.__excepthook__` to allow retrieving the original value
348of :func:`threading.excepthook` in case it is set to a broken or a different
349value.
350(Contributed by Mario Corchero in :issue:`42308`.)
351
Zackery Spytz91e93792020-11-05 15:18:44 -0700352traceback
353---------
354
355The :func:`~traceback.format_exception`,
356:func:`~traceback.format_exception_only`, and
357:func:`~traceback.print_exception` functions can now take an exception object
358as a positional-only argument.
359(Contributed by Zackery Spytz and Matthias Bussonnier in :issue:`26389`.)
360
Bas van Beek0d0e9fe2020-09-22 17:55:34 +0200361types
362-----
363
364Reintroduced the :data:`types.EllipsisType`, :data:`types.NoneType`
365and :data:`types.NotImplementedType` classes, providing a new set
366of types readily interpretable by type checkers.
367(Contributed by Bas van Beek in :issue:`41810`.)
368
kj46873382020-11-19 11:44:24 +0700369typing
370------
371
372The behavior of :class:`typing.Literal` was changed to conform with :pep:`586`
373and to match the behavior of static type checkers specified in the PEP.
374
3751. ``Literal`` now de-duplicates parameters.
3762. Equality comparisons between ``Literal`` objects are now order independent.
3773. ``Literal`` comparisons now respects types. For example,
378 ``Literal[0] == Literal[False]`` previously evaluated to ``True``. It is
379 now ``False``. To support this change, the internally used type cache now
380 supports differentiating types.
3814. ``Literal`` objects will now raise a :exc:`TypeError` exception during
382 equality comparisons if one of their parameters are not :term:`immutable`.
383 Note that declaring ``Literal`` with mutable parameters will not throw
384 an error::
385
386 >>> from typing import Literal
387 >>> Literal[{0}]
388 >>> Literal[{0}] == Literal[{False}]
389 Traceback (most recent call last):
390 File "<stdin>", line 1, in <module>
391 TypeError: unhashable type: 'set'
392
393(Contributed by Yurii Karabas in :issue:`42345`.)
394
Mark Dickinsonc8c70e72020-09-19 21:38:11 +0100395unittest
396--------
397
398Add new method :meth:`~unittest.TestCase.assertNoLogs` to complement the
399existing :meth:`~unittest.TestCase.assertLogs`. (Contributed by Kit Yan Choi
400in :issue:`39385`.)
401
Zackery Spytze28b8c92020-08-09 04:50:53 -0600402xml
403---
404
405Add a :class:`~xml.sax.handler.LexicalHandler` class to the
406:mod:`xml.sax.handler` module.
407(Contributed by Jonathan Gossage and Zackery Spytz in :issue:`35018`.)
408
Brett Cannond2e94bb2020-11-13 15:14:58 -0800409zipimport
410---------
411Add methods related to :pep:`451`: :meth:`~zipimport.zipimporter.find_spec`,
412:meth:`zipimport.zipimporter.create_module`, and
413:meth:`zipimport.zipimporter.exec_module`.
414(Contributed by Brett Cannon in :issue:`42131`.
415
Serhiy Storchaka8a64cea2020-06-18 22:08:27 +0300416
Pablo Galindod4fe0982020-05-19 03:33:01 +0100417Optimizations
418=============
419
Serhiy Storchaka12f43342020-07-20 15:53:55 +0300420* Constructors :func:`str`, :func:`bytes` and :func:`bytearray` are now faster
421 (around 30--40% for small objects).
422 (Contributed by Serhiy Storchaka in :issue:`41334`.)
423
Victor Stinner2c2a4f32020-06-18 01:20:51 +0200424* The :mod:`runpy` module now imports fewer modules.
Victor Stinner4c18fc82020-06-17 23:58:58 +0200425 The ``python3 -m module-name`` command startup time is 1.3x faster in
426 average.
427 (Contributed by Victor Stinner in :issue:`41006`.)
428
Pablo Galindo109826c2020-10-20 06:22:44 +0100429* The ``LOAD_ATTR`` instruction now uses new "per opcode cache" mechanism.
430 It is about 36% faster now. (Contributed by Pablo Galindo and Yury Selivanov
Matti Picus99608c72020-10-30 16:52:39 +0200431 in :issue:`42093`, based on ideas implemented originally in PyPy and MicroPython.)
Pablo Galindod4fe0982020-05-19 03:33:01 +0100432
Pablo Galindob451b0e2020-10-21 22:46:52 +0100433* When building Python with ``--enable-optimizations`` now
434 ``-fno-semantic-interposition`` is added to both the compile and link line.
435 This speeds builds of the Python interpreter created with ``--enable-shared``
436 with ``gcc`` by up to 30%. See `this article
437 <https://developers.redhat.com/blog/2020/06/25/red-hat-enterprise-linux-8-2-brings-faster-python-3-8-run-speeds/>`_
438 for more details. (Contributed by Victor Stinner and Pablo Galindo in
Brett Cannon2de50972020-12-04 15:39:21 -0800439 :issue:`38980`.)
440
Pablo Galindob451b0e2020-10-21 22:46:52 +0100441
Yurii Karabas73019792020-11-25 12:43:18 +0200442* Function parameters and their annotations are no longer computed at runtime,
443 but rather at compilation time. They are stored as a tuple of strings at the
444 bytecode level. It is now around 100% faster to create a function with parameter
445 annotations. (Contributed by Yurii Karabas and Inada Naoki in :issue:`42202`)
446
Pablo Galindod4fe0982020-05-19 03:33:01 +0100447Deprecated
448==========
449
Brett Cannon04523c52020-10-23 18:10:54 -0700450* Starting in this release, there will be a concerted effort to begin
451 cleaning up old import semantics that were kept for Python 2.7
452 compatibility. Specifically,
453 :meth:`~importlib.abc.PathEntryFinder.find_loader`/:meth:`~importlib.abc.Finder.find_module`
454 (superseded by :meth:`~importlib.abc.Finder.find_spec`),
455 :meth:`~importlib.abc.Loader.load_module`
456 (superseded by :meth:`~importlib.abc.Loader.exec_module`),
457 :meth:`~importlib.abc.Loader.module_repr` (which the import system
458 takes care of for you), the ``__package__`` attribute
459 (superseded by ``__spec__.parent``), the ``__loader__`` attribute
460 (superseded by ``__spec__.loader``), and the ``__cached__`` attribute
461 (superseded by ``__spec__.cached``) will slowly be removed (as well
462 as other classes and methods in :mod:`importlib`).
463 :exc:`ImportWarning` and/or :exc:`DeprecationWarning` will be raised
464 as appropriate to help identify code which needs updating during
465 this transition.
466
Brett Cannon2de50972020-12-04 15:39:21 -0800467* The various ``load_module()`` methods of :mod:`importlib` have been
468 documented as deprecated since Python 3.6, but will now also trigger
469 a :exc:`DeprecationWarning`. Use
470 :meth:`~importlib.abc.Loader.exec_module` instead.
471 (Contributed by Brett Cannon in :issue:`26131`.)
472
473* :meth:`zimport.zipimporter.load_module` has been deprecated in
474 preference for :meth:`~zipimport.zipimporter.exec_module`.
475 (Contributed by Brett Cannon in :issue:`26131`.)
476
477* The use of :meth:`~importlib.abc.Loader.load_module` by the import
478 system now triggers an :exc:`ImportWarning` as
479 :meth:`~importlib.abc.Loader.exec_module` is preferred.
480 (Contributed by Brett Cannon in :issue:`26131`.)
481
Erlend Egeberg Aaslanda1f401a2020-11-17 16:55:12 +0100482* ``sqlite3.OptimizedUnicode`` has been undocumented and obsolete since Python
483 3.3, when it was made an alias to :class:`str`. It is now deprecated,
484 scheduled for removal in Python 3.12.
485 (Contributed by Erlend E. Aasland in :issue:`42264`.)
486
Pablo Galindod4fe0982020-05-19 03:33:01 +0100487
Pablo Galindod4fe0982020-05-19 03:33:01 +0100488Removed
489=======
490
Serhiy Storchakae2ec0b22020-10-09 14:14:37 +0300491* Removed special methods ``__int__``, ``__float__``, ``__floordiv__``,
492 ``__mod__``, ``__divmod__``, ``__rfloordiv__``, ``__rmod__`` and
493 ``__rdivmod__`` of the :class:`complex` class. They always raised
494 a :exc:`TypeError`.
495 (Contributed by Serhiy Storchaka in :issue:`41974`.)
496
Berker Peksagd4d127f2020-07-16 09:38:58 +0300497* The ``ParserBase.error()`` method from the private and undocumented ``_markupbase``
498 module has been removed. :class:`html.parser.HTMLParser` is the only subclass of
499 ``ParserBase`` and its ``error()`` implementation has already been removed in
500 Python 3.5.
501 (Contributed by Berker Peksag in :issue:`31844`.)
502
Victor Stinner84f73822020-10-27 04:36:22 +0100503* Removed the ``unicodedata.ucnhash_CAPI`` attribute which was an internal
504 PyCapsule object. The related private ``_PyUnicode_Name_CAPI`` structure was
505 moved to the internal C API.
506 (Contributed by Victor Stinner in :issue:`42157`.)
507
Lysandros Nikolaouc26d5912020-11-16 20:46:37 +0200508* Removed the ``parser`` module, which was deprecated in 3.9 due to the
509 switch to the new PEG parser, as well as all the C source and header files
510 that were only being used by the old parser, including ``node.h``, ``parser.h``,
511 ``graminit.h`` and ``grammar.h``.
512
513* Removed the Public C API functions :c:func:`PyParser_SimpleParseStringFlags`,
514 :c:func:`PyParser_SimpleParseStringFlagsFilename`,
515 :c:func:`PyParser_SimpleParseFileFlags` and :c:func:`PyNode_Compile`
516 that were deprecated in 3.9 due to the switch to the new PEG parser.
517
Dong-hee Nabe319c02020-11-25 22:17:30 +0900518* Removed the ``formatter`` module, which was deprecated in Python 3.4.
519 It is somewhat obsolete, little used, and not tested. It was originally
520 scheduled to be removed in Python 3.6, but such removals were delayed until
521 after Python 2.7 EOL. Existing users should copy whatever classes they use
522 into their code.
523 (Contributed by Dong-hee Na and Terry J. Reedy in :issue:`42299`.)
Pablo Galindod4fe0982020-05-19 03:33:01 +0100524
Hai Shi0f91f582020-12-08 22:42:42 +0800525* Removed the :c:func:`PyModule_GetWarningsModule` function that was useless
526 now due to the _warnings module was converted to a builtin module in 2.6.
527 (Contributed by Hai Shi in :issue:`42599`.)
528
529
Pablo Galindod4fe0982020-05-19 03:33:01 +0100530Porting to Python 3.10
531======================
532
533This section lists previously described changes and other bugfixes
534that may require changes to your code.
535
536
Zackery Spytz91e93792020-11-05 15:18:44 -0700537Changes in the Python API
538-------------------------
539
540* The *etype* parameters of the :func:`~traceback.format_exception`,
541 :func:`~traceback.format_exception_only`, and
542 :func:`~traceback.print_exception` functions in the :mod:`traceback` module
543 have been renamed to *exc*.
544 (Contributed by Zackery Spytz and Matthias Bussonnier in :issue:`26389`.)
545
Victor Stinner357704c2020-12-14 23:07:54 +0100546* :mod:`atexit`: At Python exit, if a callback registered with
547 :func:`atexit.register` fails, its exception is now logged. Previously, only
548 some exceptions were logged, and the last exception was always silently
549 ignored.
550 (Contributed by Victor Stinner in :issue:`42639`.)
551
kjd75f6f72020-12-19 01:39:26 +0800552* :class:`collections.abc.Callable` generic now flattens type parameters, similar
553 to what :data:`typing.Callable` currently does. This means that
554 ``collections.abc.Callable[[int, str], str]`` will have ``__args__`` of
555 ``(int, str, str)``; previously this was ``([int, str], str)``. Code which
556 accesses the arguments via :func:`typing.get_args` or ``__args__`` need to account
557 for this change. Furthermore, :exc:`TypeError` may be raised for invalid forms
558 of parameterizing :class:`collections.abc.Callable` which may have passed
559 silently in Python 3.9.
560 (Contributed by Ken Jin in :issue:`42195`.)
Victor Stinner357704c2020-12-14 23:07:54 +0100561
Erlend Egeberg Aaslandf4936ad2020-12-31 14:16:50 +0100562* :meth:`socket.htons` and :meth:`socket.ntohs` now raise :exc:`OverflowError`
563 instead of :exc:`DeprecationWarning` if the given parameter will not fit in
564 a 16-bit unsigned integer.
565 (Contributed by Erlend E. Aasland in :issue:`42393`.)
566
567
Yurii Karabas73019792020-11-25 12:43:18 +0200568CPython bytecode changes
569========================
570
571* The ``MAKE_FUNCTION`` instruction accepts tuple of strings as annotations
572 instead of dictionary.
573 (Contributed by Yurii Karabas and Inada Naoki in :issue:`42202`)
Dong-hee Naad3252b2020-05-26 01:52:54 +0900574
575Build Changes
576=============
577
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200578
Victor Stinner7ab92d52020-06-16 00:54:44 +0200579* The C99 functions :c:func:`snprintf` and :c:func:`vsnprintf` are now required
580 to build Python.
581 (Contributed by Victor Stinner in :issue:`36020`.)
582
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200583* :mod:`sqlite3` requires SQLite 3.7.3 or higher.
584 (Contributed by Sergey Fedoseev and Erlend E. Aasland :issue:`40744`.)
585
Victor Stinner357704c2020-12-14 23:07:54 +0100586* The :mod:`atexit` module must now always be built as a built-in module.
587 (Contributed by Victor Stinner in :issue:`42639`.)
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200588
pxinwr277ce302020-12-30 20:50:39 +0800589* Added ``--disable-test-modules`` option to the ``configure`` script:
590 don't build nor install test modules.
591 (Contributed by Xavier de Gaye, Thomas Petazzoni and Peixing Xin in :issue:`27640`.)
592
Dong-hee Naad3252b2020-05-26 01:52:54 +0900593
594C API Changes
595=============
596
597New Features
598------------
599
Victor Stinnerdd8a93e2020-06-30 00:49:03 +0200600* The result of :c:func:`PyNumber_Index` now always has exact type :class:`int`.
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +0300601 Previously, the result could have been an instance of a subclass of ``int``.
602 (Contributed by Serhiy Storchaka in :issue:`40792`.)
603
Victor Stinnerdd8a93e2020-06-30 00:49:03 +0200604* Add a new :c:member:`~PyConfig.orig_argv` member to the :c:type:`PyConfig`
605 structure: the list of the original command line arguments passed to the
606 Python executable.
607 (Contributed by Victor Stinner in :issue:`23427`.)
Dong-hee Naad3252b2020-05-26 01:52:54 +0900608
Zackery Spytz2e4dd332020-09-23 12:43:45 -0600609* The :c:func:`PyDateTime_DATE_GET_TZINFO` and
610 :c:func:`PyDateTime_TIME_GET_TZINFO` macros have been added for accessing
611 the ``tzinfo`` attributes of :class:`datetime.datetime` and
612 :class:`datetime.time` objects.
613 (Contributed by Zackery Spytz in :issue:`30155`.)
614
Hai Shid332e7b2020-09-29 05:41:11 +0800615* Add a :c:func:`PyCodec_Unregister` function to unregister a codec
616 search function.
617 (Contributed by Hai Shi in :issue:`41842`.)
618
Vladimir Matveev24a54c02020-10-12 12:10:42 -0700619* The :c:func:`PyIter_Send` function was added to allow
Vladimir Matveev037245c2020-10-09 17:15:15 -0700620 sending value into iterator without raising ``StopIteration`` exception.
621 (Contributed by Vladimir Matveev in :issue:`41756`.)
622
Alex Gaynor3a8fdb22020-10-19 18:17:50 -0400623* Added :c:func:`PyUnicode_AsUTF8AndSize` to the limited C API.
624 (Contributed by Alex Gaynor in :issue:`41784`.)
625
Victor Stinner80218752020-11-04 13:59:15 +0100626* Added :c:func:`PyModule_AddObjectRef` function: similar to
Victor Stinner95ce7cd2020-11-11 01:52:26 +0100627 :c:func:`PyModule_AddObject` but don't steal a reference to the value on
Victor Stinner80218752020-11-04 13:59:15 +0100628 success.
629 (Contributed by Victor Stinner in :issue:`1635741`.)
630
Victor Stinner53a03aa2020-11-05 15:02:12 +0100631* Added :c:func:`Py_NewRef` and :c:func:`Py_XNewRef` functions to increment the
632 reference count of an object and return the object.
633 (Contributed by Victor Stinner in :issue:`42262`.)
634
Serhiy Storchaka686c2032020-11-22 13:25:02 +0200635* The :c:func:`PyType_FromSpecWithBases` and :c:func:`PyType_FromModuleAndSpec`
636 functions now accept a single class as the *bases* argument.
637 (Contributed by Serhiy Storchaka in :issue:`42423`.)
638
Hai Shi88c2cfd2020-11-07 00:04:47 +0800639* The :c:func:`PyType_FromModuleAndSpec` function now accepts NULL ``tp_doc``
640 slot.
641 (Contributed by Hai Shi in :issue:`41832`.)
642
Hai Shia13b26c2020-11-11 04:53:46 +0800643* The :c:func:`PyType_GetSlot` function can accept static types.
644 (Contributed by Hai Shi and Petr Viktorin in :issue:`41073`.)
645
Alex Gaynor3a8fdb22020-10-19 18:17:50 -0400646
Dong-hee Naad3252b2020-05-26 01:52:54 +0900647Porting to Python 3.10
648----------------------
649
Victor Stinner37bb2892020-06-19 11:45:31 +0200650* The ``PY_SSIZE_T_CLEAN`` macro must now be defined to use
651 :c:func:`PyArg_ParseTuple` and :c:func:`Py_BuildValue` formats which use
652 ``#``: ``es#``, ``et#``, ``s#``, ``u#``, ``y#``, ``z#``, ``U#`` and ``Z#``.
653 See :ref:`Parsing arguments and building values
654 <arg-parsing>` and the :pep:`353`.
655 (Contributed by Victor Stinner in :issue:`40943`.)
656
Victor Stinnerfe2978b2020-05-27 14:55:10 +0200657* Since :c:func:`Py_REFCNT()` is changed to the inline static function,
658 ``Py_REFCNT(obj) = new_refcnt`` must be replaced with ``Py_SET_REFCNT(obj, new_refcnt)``:
Victor Stinnerdc24b8a2020-06-04 22:10:43 +0200659 see :c:func:`Py_SET_REFCNT()` (available since Python 3.9). For backward
660 compatibility, this macro can be used::
661
662 #if PY_VERSION_HEX < 0x030900A4
663 # define Py_SET_REFCNT(obj, refcnt) ((Py_REFCNT(obj) = (refcnt)), (void)0)
664 #endif
665
Victor Stinnerfe2978b2020-05-27 14:55:10 +0200666 (Contributed by Victor Stinner in :issue:`39573`.)
667
Victor Stinner59d3dce2020-06-02 14:03:25 +0200668* Calling :c:func:`PyDict_GetItem` without :term:`GIL` held had been allowed
669 for historical reason. It is no longer allowed.
670 (Contributed by Victor Stinner in :issue:`40839`.)
671
Inada Naoki038dd0f2020-06-30 15:26:56 +0900672* ``PyUnicode_FromUnicode(NULL, size)`` and ``PyUnicode_FromStringAndSize(NULL, size)``
673 raise ``DeprecationWarning`` now. Use :c:func:`PyUnicode_New` to allocate
674 Unicode object without initial data.
675 (Contributed by Inada Naoki in :issue:`36346`.)
676
Victor Stinner47e1afd2020-10-26 16:43:47 +0100677* The private ``_PyUnicode_Name_CAPI`` structure of the PyCapsule API
Victor Stinner84f73822020-10-27 04:36:22 +0100678 ``unicodedata.ucnhash_CAPI`` has been moved to the internal C API.
Victor Stinner920cb642020-10-26 19:19:36 +0100679 (Contributed by Victor Stinner in :issue:`42157`.)
Victor Stinner47e1afd2020-10-26 16:43:47 +0100680
Victor Stinnerace3f9a2020-11-10 21:10:22 +0100681* :c:func:`Py_GetPath`, :c:func:`Py_GetPrefix`, :c:func:`Py_GetExecPrefix`,
682 :c:func:`Py_GetProgramFullPath`, :c:func:`Py_GetPythonHome` and
683 :c:func:`Py_GetProgramName` functions now return ``NULL`` if called before
684 :c:func:`Py_Initialize` (before Python is initialized). Use the new
685 :ref:`Python Initialization Configuration API <init-config>` to get the
686 :ref:`Python Path Configuration. <init-path-config>`.
687 (Contributed by Victor Stinner in :issue:`42260`.)
688
Victor Stinner0ef96c22020-12-07 11:56:20 +0100689* :c:func:`PyList_SET_ITEM`, :c:func:`PyTuple_SET_ITEM` and
690 :c:func:`PyCell_SET` macros can no longer be used as l-value or r-value.
691 For example, ``x = PyList_SET_ITEM(a, b, c)`` and
692 ``PyList_SET_ITEM(a, b, c) = x`` now fail with a compiler error. It prevents
693 bugs like ``if (PyList_SET_ITEM (a, b, c) < 0) ...`` test.
694 (Contributed by Zackery Spytz and Victor Stinner in :issue:`30459`.)
695
Victor Stinner583ee5a2020-10-02 14:49:00 +0200696Deprecated
697----------
698
699* The ``PyUnicode_InternImmortal()`` function is now deprecated
700 and will be removed in Python 3.12: use :c:func:`PyUnicode_InternInPlace`
701 instead.
702 (Contributed by Victor Stinner in :issue:`41692`.)
703
Dong-hee Naad3252b2020-05-26 01:52:54 +0900704Removed
705-------
Inada Naoki6f8a6ee2020-06-26 08:07:22 +0900706
707* ``PyObject_AsCharBuffer()``, ``PyObject_AsReadBuffer()``, ``PyObject_CheckReadBuffer()``,
708 and ``PyObject_AsWriteBuffer()`` are removed. Please migrate to new buffer protocol;
709 :c:func:`PyObject_GetBuffer` and :c:func:`PyBuffer_Release`.
Inada Naoki20a79022020-06-27 18:22:09 +0900710 (Contributed by Inada Naoki in :issue:`41103`.)
711
712* Removed ``Py_UNICODE_str*`` functions manipulating ``Py_UNICODE*`` strings.
713 (Contributed by Inada Naoki in :issue:`41123`.)
714
715 * ``Py_UNICODE_strlen``: use :c:func:`PyUnicode_GetLength` or
716 :c:macro:`PyUnicode_GET_LENGTH`
717 * ``Py_UNICODE_strcat``: use :c:func:`PyUnicode_CopyCharacters` or
718 :c:func:`PyUnicode_FromFormat`
719 * ``Py_UNICODE_strcpy``, ``Py_UNICODE_strncpy``: use
720 :c:func:`PyUnicode_CopyCharacters` or :c:func:`PyUnicode_Substring`
721 * ``Py_UNICODE_strcmp``: use :c:func:`PyUnicode_Compare`
722 * ``Py_UNICODE_strncmp``: use :c:func:`PyUnicode_Tailmatch`
723 * ``Py_UNICODE_strchr``, ``Py_UNICODE_strrchr``: use
724 :c:func:`PyUnicode_FindChar`
Inada Naokid9f2a132020-06-29 10:46:51 +0900725
726* Removed ``PyUnicode_GetMax()``. Please migrate to new (:pep:`393`) APIs.
727 (Contributed by Inada Naoki in :issue:`41103`.)
Inada Naokie4f1fe62020-06-29 13:00:43 +0900728
729* Removed ``PyLong_FromUnicode()``. Please migrate to :c:func:`PyLong_FromUnicodeObject`.
730 (Contributed by Inada Naoki in :issue:`41103`.)
Inada Naokib3332662020-06-30 12:23:07 +0900731
732* Removed ``PyUnicode_AsUnicodeCopy()``. Please use :c:func:`PyUnicode_AsUCS4Copy` or
733 :c:func:`PyUnicode_AsWideCharString`
734 (Contributed by Inada Naoki in :issue:`41103`.)
Victor Stinner19c3ac92020-09-23 14:04:57 +0200735
736* Removed ``_Py_CheckRecursionLimit`` variable: it has been replaced by
737 ``ceval.recursion_limit`` of the :c:type:`PyInterpreterState` structure.
738 (Contributed by Victor Stinner in :issue:`41834`.)
Serhiy Storchakadcc54212020-10-05 12:32:00 +0300739
740* Removed undocumented macros ``Py_ALLOW_RECURSION`` and
741 ``Py_END_ALLOW_RECURSION`` and the ``recursion_critical`` field of the
742 :c:type:`PyInterpreterState` structure.
743 (Contributed by Serhiy Storchaka in :issue:`41936`.)
Victor Stinner296a7962020-11-17 16:22:23 +0100744
745* Removed the undocumented ``PyOS_InitInterrupts()`` function. Initializing
746 Python already implicitly installs signal handlers: see
747 :c:member:`PyConfig.install_signal_handlers`.
748 (Contributed by Victor Stinner in :issue:`41713`.)