blob: 019dd1817d2b63ba431c6fb078f50f84438c03c2 [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
147Other Language Changes
148======================
149
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300150* Builtin and extension functions that take integer arguments no longer accept
151 :class:`~decimal.Decimal`\ s, :class:`~fractions.Fraction`\ s and other
152 objects that can be converted to integers only with a loss (e.g. that have
153 the :meth:`~object.__int__` method but do not have the
154 :meth:`~object.__index__` method).
155 (Contributed by Serhiy Storchaka in :issue:`37999`.)
Pablo Galindod4fe0982020-05-19 03:33:01 +0100156
Lysandros Nikolaoua85fefe2020-11-19 01:49:28 +0200157* Assignment expressions can now be used unparenthesized within set literals
158 and set comprehensions, as well as in sequence indexes (but not slices).
159
Pablo Galindod4fe0982020-05-19 03:33:01 +0100160
161New Modules
162===========
163
164* None yet.
165
166
167Improved Modules
168================
169
Filipe LaĆ­ns4ce6faa2020-08-10 15:48:20 +0100170base64
171------
172
173Add :func:`base64.b32hexencode` and :func:`base64.b32hexdecode` to support the
174Base32 Encoding with Extended Hex Alphabet.
175
Hai Shid332e7b2020-09-29 05:41:11 +0800176codecs
177------
178
179Add a :func:`codecs.unregister` function to unregister a codec search function.
180(Contributed by Hai Shi in :issue:`41842`.)
181
Joongi Kim3eb28462020-11-11 00:19:11 +0900182contextlib
183----------
184
185Add a :func:`contextlib.aclosing` context manager to safely close async generators
186and objects representing asynchronously released resources.
187(Contributed by Joongi Kim and John Belmonte in :issue:`41229`.)
188
Tom Gringauz9c98e8c2020-11-18 00:58:35 +0200189Add asynchronous context manager support to :func:`contextlib.nullcontext`.
190(Contributed by Tom Gringauz in :issue:`41543`.)
191
Hans Petter Janssonda4e09f2020-08-03 22:51:33 -0500192curses
193------
194
195The extended color functions added in ncurses 6.1 will be used transparently
196by :func:`curses.color_content`, :func:`curses.init_color`,
197:func:`curses.init_pair`, and :func:`curses.pair_content`. A new function,
198:func:`curses.has_extended_color_support`, indicates whether extended color
199support is provided by the underlying ncurses library.
200(Contributed by Jeffrey Kintscher and Hans Petter Jansson in :issue:`36982`.)
201
Brett Cannon825ac382020-11-06 18:45:56 -0800202doctest
203-------
204
205When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
206(Contributed by Brett Cannon in :issue:`42133`.)
207
Hai Shic5b049b2020-10-14 23:43:31 +0800208encodings
209---------
210:func:`encodings.normalize_encoding` now ignores non-ASCII characters.
211(Contributed by Hai Shi in :issue:`39337`.)
212
Serhiy Storchaka8a64cea2020-06-18 22:08:27 +0300213glob
214----
215
216Added the *root_dir* and *dir_fd* parameters in :func:`~glob.glob` and
217:func:`~glob.iglob` which allow to specify the root directory for searching.
218(Contributed by Serhiy Storchaka in :issue:`38144`.)
219
Brett Cannon825ac382020-11-06 18:45:56 -0800220inspect
221-------
222
223When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
224(Contributed by Brett Cannon in :issue:`42133`.)
225
226linecache
227---------
228
229When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
230(Contributed by Brett Cannon in :issue:`42133`.)
231
pxinwr3405e052020-08-07 13:21:52 +0800232os
233--
234
235Added :func:`os.cpu_count()` support for VxWorks RTOS.
236(Contributed by Peixing Xin in :issue:`41440`.)
237
Christian Heimescd9fed62020-11-13 19:48:52 +0100238Added a new function :func:`os.eventfd` and related helpers to wrap the
239``eventfd2`` syscall on Linux.
240(Contributed by Christian Heimes in :issue:`41001`.)
241
Pablo Galindoa57b3d32020-11-17 00:00:38 +0000242Added :func:`os.splice()` that allows to move data between two file
243descriptors without copying between kernel address space and user
244address space, where one of the file descriptors must refer to a
245pipe. (Contributed by Pablo Galindo in :issue:`41625`.)
246
Joshua Cannon45205842020-11-20 09:40:39 -0600247pathlib
248-------
249
Yaroslav Pankovych79d2e622020-11-23 22:06:22 +0200250Added slice support to :attr:`PurePath.parents <pathlib.PurePath.parents>`.
Joshua Cannon45205842020-11-20 09:40:39 -0600251(Contributed by Joshua Cannon in :issue:`35498`)
252
Yaroslav Pankovych79d2e622020-11-23 22:06:22 +0200253Added negative indexing support to :attr:`PurePath.parents
254<pathlib.PurePath.parents>`.
255(Contributed by Yaroslav Pankovych in :issue:`21041`)
256
Christian Heimes5c73afc2020-11-30 22:34:45 +0100257platform
258--------
259
260Added :func:`platform.freedesktop_os_release()` to retrieve operation system
261identification from `freedesktop.org os-release
262<https://www.freedesktop.org/software/systemd/man/os-release.html>`_ standard file.
263(Contributed by Christian Heimes in :issue:`28468`)
264
Gregory Schevchenkodaff3902020-07-25 22:58:45 +0300265py_compile
266----------
267
268Added ``--quiet`` option to command-line interface of :mod:`py_compile`.
269(Contributed by Gregory Schevchenko in :issue:`38731`.)
270
Zackery Spytzdf592732020-10-29 03:44:35 -0600271shelve
272------
273
274The :mod:`shelve` module now uses :data:`pickle.DEFAULT_PROTOCOL` by default
275instead of :mod:`pickle` protocol ``3`` when creating shelves.
276(Contributed by Zackery Spytz in :issue:`34204`.)
277
Brett Cannon825ac382020-11-06 18:45:56 -0800278site
279----
280
281When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
282(Contributed by Brett Cannon in :issue:`42133`.)
283
Christian Heimes03c8ddd2020-11-20 09:26:07 +0100284socket
285------
286
287The exception :exc:`socket.timeout` is now an alias of :exc:`TimeoutError`.
288(Contributed by Christian Heimes in :issue:`42413`.)
289
Victor Stinnerdd8a93e2020-06-30 00:49:03 +0200290sys
291---
292
293Add :data:`sys.orig_argv` attribute: the list of the original command line
294arguments passed to the Python executable.
295(Contributed by Victor Stinner in :issue:`23427`.)
296
Mario Corchero0001a1b2020-11-04 10:27:43 +0100297threading
298---------
299
300Added :func:`threading.gettrace` and :func:`threading.getprofile` to
301retrieve the functions set by :func:`threading.settrace` and
302:func:`threading.setprofile` respectively.
303(Contributed by Mario Corchero in :issue:`42251`.)
304
Mario Corchero750c5ab2020-11-12 18:27:44 +0100305Add :data:`threading.__excepthook__` to allow retrieving the original value
306of :func:`threading.excepthook` in case it is set to a broken or a different
307value.
308(Contributed by Mario Corchero in :issue:`42308`.)
309
Zackery Spytz91e93792020-11-05 15:18:44 -0700310traceback
311---------
312
313The :func:`~traceback.format_exception`,
314:func:`~traceback.format_exception_only`, and
315:func:`~traceback.print_exception` functions can now take an exception object
316as a positional-only argument.
317(Contributed by Zackery Spytz and Matthias Bussonnier in :issue:`26389`.)
318
Bas van Beek0d0e9fe2020-09-22 17:55:34 +0200319types
320-----
321
322Reintroduced the :data:`types.EllipsisType`, :data:`types.NoneType`
323and :data:`types.NotImplementedType` classes, providing a new set
324of types readily interpretable by type checkers.
325(Contributed by Bas van Beek in :issue:`41810`.)
326
kj46873382020-11-19 11:44:24 +0700327typing
328------
329
330The behavior of :class:`typing.Literal` was changed to conform with :pep:`586`
331and to match the behavior of static type checkers specified in the PEP.
332
3331. ``Literal`` now de-duplicates parameters.
3342. Equality comparisons between ``Literal`` objects are now order independent.
3353. ``Literal`` comparisons now respects types. For example,
336 ``Literal[0] == Literal[False]`` previously evaluated to ``True``. It is
337 now ``False``. To support this change, the internally used type cache now
338 supports differentiating types.
3394. ``Literal`` objects will now raise a :exc:`TypeError` exception during
340 equality comparisons if one of their parameters are not :term:`immutable`.
341 Note that declaring ``Literal`` with mutable parameters will not throw
342 an error::
343
344 >>> from typing import Literal
345 >>> Literal[{0}]
346 >>> Literal[{0}] == Literal[{False}]
347 Traceback (most recent call last):
348 File "<stdin>", line 1, in <module>
349 TypeError: unhashable type: 'set'
350
351(Contributed by Yurii Karabas in :issue:`42345`.)
352
Mark Dickinsonc8c70e72020-09-19 21:38:11 +0100353unittest
354--------
355
356Add new method :meth:`~unittest.TestCase.assertNoLogs` to complement the
357existing :meth:`~unittest.TestCase.assertLogs`. (Contributed by Kit Yan Choi
358in :issue:`39385`.)
359
Zackery Spytze28b8c92020-08-09 04:50:53 -0600360xml
361---
362
363Add a :class:`~xml.sax.handler.LexicalHandler` class to the
364:mod:`xml.sax.handler` module.
365(Contributed by Jonathan Gossage and Zackery Spytz in :issue:`35018`.)
366
Brett Cannond2e94bb2020-11-13 15:14:58 -0800367zipimport
368---------
369Add methods related to :pep:`451`: :meth:`~zipimport.zipimporter.find_spec`,
370:meth:`zipimport.zipimporter.create_module`, and
371:meth:`zipimport.zipimporter.exec_module`.
372(Contributed by Brett Cannon in :issue:`42131`.
373
Serhiy Storchaka8a64cea2020-06-18 22:08:27 +0300374
Pablo Galindod4fe0982020-05-19 03:33:01 +0100375Optimizations
376=============
377
Serhiy Storchaka12f43342020-07-20 15:53:55 +0300378* Constructors :func:`str`, :func:`bytes` and :func:`bytearray` are now faster
379 (around 30--40% for small objects).
380 (Contributed by Serhiy Storchaka in :issue:`41334`.)
381
Victor Stinner2c2a4f32020-06-18 01:20:51 +0200382* The :mod:`runpy` module now imports fewer modules.
Victor Stinner4c18fc82020-06-17 23:58:58 +0200383 The ``python3 -m module-name`` command startup time is 1.3x faster in
384 average.
385 (Contributed by Victor Stinner in :issue:`41006`.)
386
Pablo Galindo109826c2020-10-20 06:22:44 +0100387* The ``LOAD_ATTR`` instruction now uses new "per opcode cache" mechanism.
388 It is about 36% faster now. (Contributed by Pablo Galindo and Yury Selivanov
Matti Picus99608c72020-10-30 16:52:39 +0200389 in :issue:`42093`, based on ideas implemented originally in PyPy and MicroPython.)
Pablo Galindod4fe0982020-05-19 03:33:01 +0100390
Pablo Galindob451b0e2020-10-21 22:46:52 +0100391* When building Python with ``--enable-optimizations`` now
392 ``-fno-semantic-interposition`` is added to both the compile and link line.
393 This speeds builds of the Python interpreter created with ``--enable-shared``
394 with ``gcc`` by up to 30%. See `this article
395 <https://developers.redhat.com/blog/2020/06/25/red-hat-enterprise-linux-8-2-brings-faster-python-3-8-run-speeds/>`_
396 for more details. (Contributed by Victor Stinner and Pablo Galindo in
Brett Cannon2de50972020-12-04 15:39:21 -0800397 :issue:`38980`.)
398
Pablo Galindob451b0e2020-10-21 22:46:52 +0100399
Yurii Karabas73019792020-11-25 12:43:18 +0200400* Function parameters and their annotations are no longer computed at runtime,
401 but rather at compilation time. They are stored as a tuple of strings at the
402 bytecode level. It is now around 100% faster to create a function with parameter
403 annotations. (Contributed by Yurii Karabas and Inada Naoki in :issue:`42202`)
404
Pablo Galindod4fe0982020-05-19 03:33:01 +0100405Deprecated
406==========
407
Brett Cannon04523c52020-10-23 18:10:54 -0700408* Starting in this release, there will be a concerted effort to begin
409 cleaning up old import semantics that were kept for Python 2.7
410 compatibility. Specifically,
411 :meth:`~importlib.abc.PathEntryFinder.find_loader`/:meth:`~importlib.abc.Finder.find_module`
412 (superseded by :meth:`~importlib.abc.Finder.find_spec`),
413 :meth:`~importlib.abc.Loader.load_module`
414 (superseded by :meth:`~importlib.abc.Loader.exec_module`),
415 :meth:`~importlib.abc.Loader.module_repr` (which the import system
416 takes care of for you), the ``__package__`` attribute
417 (superseded by ``__spec__.parent``), the ``__loader__`` attribute
418 (superseded by ``__spec__.loader``), and the ``__cached__`` attribute
419 (superseded by ``__spec__.cached``) will slowly be removed (as well
420 as other classes and methods in :mod:`importlib`).
421 :exc:`ImportWarning` and/or :exc:`DeprecationWarning` will be raised
422 as appropriate to help identify code which needs updating during
423 this transition.
424
Brett Cannon2de50972020-12-04 15:39:21 -0800425* The various ``load_module()`` methods of :mod:`importlib` have been
426 documented as deprecated since Python 3.6, but will now also trigger
427 a :exc:`DeprecationWarning`. Use
428 :meth:`~importlib.abc.Loader.exec_module` instead.
429 (Contributed by Brett Cannon in :issue:`26131`.)
430
431* :meth:`zimport.zipimporter.load_module` has been deprecated in
432 preference for :meth:`~zipimport.zipimporter.exec_module`.
433 (Contributed by Brett Cannon in :issue:`26131`.)
434
435* The use of :meth:`~importlib.abc.Loader.load_module` by the import
436 system now triggers an :exc:`ImportWarning` as
437 :meth:`~importlib.abc.Loader.exec_module` is preferred.
438 (Contributed by Brett Cannon in :issue:`26131`.)
439
Erlend Egeberg Aaslanda1f401a2020-11-17 16:55:12 +0100440* ``sqlite3.OptimizedUnicode`` has been undocumented and obsolete since Python
441 3.3, when it was made an alias to :class:`str`. It is now deprecated,
442 scheduled for removal in Python 3.12.
443 (Contributed by Erlend E. Aasland in :issue:`42264`.)
444
Pablo Galindod4fe0982020-05-19 03:33:01 +0100445
Pablo Galindod4fe0982020-05-19 03:33:01 +0100446Removed
447=======
448
Serhiy Storchakae2ec0b22020-10-09 14:14:37 +0300449* Removed special methods ``__int__``, ``__float__``, ``__floordiv__``,
450 ``__mod__``, ``__divmod__``, ``__rfloordiv__``, ``__rmod__`` and
451 ``__rdivmod__`` of the :class:`complex` class. They always raised
452 a :exc:`TypeError`.
453 (Contributed by Serhiy Storchaka in :issue:`41974`.)
454
Berker Peksagd4d127f2020-07-16 09:38:58 +0300455* The ``ParserBase.error()`` method from the private and undocumented ``_markupbase``
456 module has been removed. :class:`html.parser.HTMLParser` is the only subclass of
457 ``ParserBase`` and its ``error()`` implementation has already been removed in
458 Python 3.5.
459 (Contributed by Berker Peksag in :issue:`31844`.)
460
Victor Stinner84f73822020-10-27 04:36:22 +0100461* Removed the ``unicodedata.ucnhash_CAPI`` attribute which was an internal
462 PyCapsule object. The related private ``_PyUnicode_Name_CAPI`` structure was
463 moved to the internal C API.
464 (Contributed by Victor Stinner in :issue:`42157`.)
465
Lysandros Nikolaouc26d5912020-11-16 20:46:37 +0200466* Removed the ``parser`` module, which was deprecated in 3.9 due to the
467 switch to the new PEG parser, as well as all the C source and header files
468 that were only being used by the old parser, including ``node.h``, ``parser.h``,
469 ``graminit.h`` and ``grammar.h``.
470
471* Removed the Public C API functions :c:func:`PyParser_SimpleParseStringFlags`,
472 :c:func:`PyParser_SimpleParseStringFlagsFilename`,
473 :c:func:`PyParser_SimpleParseFileFlags` and :c:func:`PyNode_Compile`
474 that were deprecated in 3.9 due to the switch to the new PEG parser.
475
Dong-hee Nabe319c02020-11-25 22:17:30 +0900476* Removed the ``formatter`` module, which was deprecated in Python 3.4.
477 It is somewhat obsolete, little used, and not tested. It was originally
478 scheduled to be removed in Python 3.6, but such removals were delayed until
479 after Python 2.7 EOL. Existing users should copy whatever classes they use
480 into their code.
481 (Contributed by Dong-hee Na and Terry J. Reedy in :issue:`42299`.)
Pablo Galindod4fe0982020-05-19 03:33:01 +0100482
Pablo Galindod4fe0982020-05-19 03:33:01 +0100483Porting to Python 3.10
484======================
485
486This section lists previously described changes and other bugfixes
487that may require changes to your code.
488
489
Zackery Spytz91e93792020-11-05 15:18:44 -0700490Changes in the Python API
491-------------------------
492
493* The *etype* parameters of the :func:`~traceback.format_exception`,
494 :func:`~traceback.format_exception_only`, and
495 :func:`~traceback.print_exception` functions in the :mod:`traceback` module
496 have been renamed to *exc*.
497 (Contributed by Zackery Spytz and Matthias Bussonnier in :issue:`26389`.)
498
Yurii Karabas73019792020-11-25 12:43:18 +0200499CPython bytecode changes
500========================
501
502* The ``MAKE_FUNCTION`` instruction accepts tuple of strings as annotations
503 instead of dictionary.
504 (Contributed by Yurii Karabas and Inada Naoki in :issue:`42202`)
Dong-hee Naad3252b2020-05-26 01:52:54 +0900505
506Build Changes
507=============
508
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200509
Victor Stinner7ab92d52020-06-16 00:54:44 +0200510* The C99 functions :c:func:`snprintf` and :c:func:`vsnprintf` are now required
511 to build Python.
512 (Contributed by Victor Stinner in :issue:`36020`.)
513
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +0200514* :mod:`sqlite3` requires SQLite 3.7.3 or higher.
515 (Contributed by Sergey Fedoseev and Erlend E. Aasland :issue:`40744`.)
516
517
Dong-hee Naad3252b2020-05-26 01:52:54 +0900518
519C API Changes
520=============
521
522New Features
523------------
524
Victor Stinnerdd8a93e2020-06-30 00:49:03 +0200525* The result of :c:func:`PyNumber_Index` now always has exact type :class:`int`.
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +0300526 Previously, the result could have been an instance of a subclass of ``int``.
527 (Contributed by Serhiy Storchaka in :issue:`40792`.)
528
Victor Stinnerdd8a93e2020-06-30 00:49:03 +0200529* Add a new :c:member:`~PyConfig.orig_argv` member to the :c:type:`PyConfig`
530 structure: the list of the original command line arguments passed to the
531 Python executable.
532 (Contributed by Victor Stinner in :issue:`23427`.)
Dong-hee Naad3252b2020-05-26 01:52:54 +0900533
Zackery Spytz2e4dd332020-09-23 12:43:45 -0600534* The :c:func:`PyDateTime_DATE_GET_TZINFO` and
535 :c:func:`PyDateTime_TIME_GET_TZINFO` macros have been added for accessing
536 the ``tzinfo`` attributes of :class:`datetime.datetime` and
537 :class:`datetime.time` objects.
538 (Contributed by Zackery Spytz in :issue:`30155`.)
539
Hai Shid332e7b2020-09-29 05:41:11 +0800540* Add a :c:func:`PyCodec_Unregister` function to unregister a codec
541 search function.
542 (Contributed by Hai Shi in :issue:`41842`.)
543
Vladimir Matveev24a54c02020-10-12 12:10:42 -0700544* The :c:func:`PyIter_Send` function was added to allow
Vladimir Matveev037245c2020-10-09 17:15:15 -0700545 sending value into iterator without raising ``StopIteration`` exception.
546 (Contributed by Vladimir Matveev in :issue:`41756`.)
547
Alex Gaynor3a8fdb22020-10-19 18:17:50 -0400548* Added :c:func:`PyUnicode_AsUTF8AndSize` to the limited C API.
549 (Contributed by Alex Gaynor in :issue:`41784`.)
550
Victor Stinner80218752020-11-04 13:59:15 +0100551* Added :c:func:`PyModule_AddObjectRef` function: similar to
Victor Stinner95ce7cd2020-11-11 01:52:26 +0100552 :c:func:`PyModule_AddObject` but don't steal a reference to the value on
Victor Stinner80218752020-11-04 13:59:15 +0100553 success.
554 (Contributed by Victor Stinner in :issue:`1635741`.)
555
Victor Stinner53a03aa2020-11-05 15:02:12 +0100556* Added :c:func:`Py_NewRef` and :c:func:`Py_XNewRef` functions to increment the
557 reference count of an object and return the object.
558 (Contributed by Victor Stinner in :issue:`42262`.)
559
Serhiy Storchaka686c2032020-11-22 13:25:02 +0200560* The :c:func:`PyType_FromSpecWithBases` and :c:func:`PyType_FromModuleAndSpec`
561 functions now accept a single class as the *bases* argument.
562 (Contributed by Serhiy Storchaka in :issue:`42423`.)
563
Hai Shi88c2cfd2020-11-07 00:04:47 +0800564* The :c:func:`PyType_FromModuleAndSpec` function now accepts NULL ``tp_doc``
565 slot.
566 (Contributed by Hai Shi in :issue:`41832`.)
567
Hai Shia13b26c2020-11-11 04:53:46 +0800568* The :c:func:`PyType_GetSlot` function can accept static types.
569 (Contributed by Hai Shi and Petr Viktorin in :issue:`41073`.)
570
Alex Gaynor3a8fdb22020-10-19 18:17:50 -0400571
Dong-hee Naad3252b2020-05-26 01:52:54 +0900572Porting to Python 3.10
573----------------------
574
Victor Stinner37bb2892020-06-19 11:45:31 +0200575* The ``PY_SSIZE_T_CLEAN`` macro must now be defined to use
576 :c:func:`PyArg_ParseTuple` and :c:func:`Py_BuildValue` formats which use
577 ``#``: ``es#``, ``et#``, ``s#``, ``u#``, ``y#``, ``z#``, ``U#`` and ``Z#``.
578 See :ref:`Parsing arguments and building values
579 <arg-parsing>` and the :pep:`353`.
580 (Contributed by Victor Stinner in :issue:`40943`.)
581
Victor Stinnerfe2978b2020-05-27 14:55:10 +0200582* Since :c:func:`Py_REFCNT()` is changed to the inline static function,
583 ``Py_REFCNT(obj) = new_refcnt`` must be replaced with ``Py_SET_REFCNT(obj, new_refcnt)``:
Victor Stinnerdc24b8a2020-06-04 22:10:43 +0200584 see :c:func:`Py_SET_REFCNT()` (available since Python 3.9). For backward
585 compatibility, this macro can be used::
586
587 #if PY_VERSION_HEX < 0x030900A4
588 # define Py_SET_REFCNT(obj, refcnt) ((Py_REFCNT(obj) = (refcnt)), (void)0)
589 #endif
590
Victor Stinnerfe2978b2020-05-27 14:55:10 +0200591 (Contributed by Victor Stinner in :issue:`39573`.)
592
Victor Stinner59d3dce2020-06-02 14:03:25 +0200593* Calling :c:func:`PyDict_GetItem` without :term:`GIL` held had been allowed
594 for historical reason. It is no longer allowed.
595 (Contributed by Victor Stinner in :issue:`40839`.)
596
Inada Naoki038dd0f2020-06-30 15:26:56 +0900597* ``PyUnicode_FromUnicode(NULL, size)`` and ``PyUnicode_FromStringAndSize(NULL, size)``
598 raise ``DeprecationWarning`` now. Use :c:func:`PyUnicode_New` to allocate
599 Unicode object without initial data.
600 (Contributed by Inada Naoki in :issue:`36346`.)
601
Victor Stinner47e1afd2020-10-26 16:43:47 +0100602* The private ``_PyUnicode_Name_CAPI`` structure of the PyCapsule API
Victor Stinner84f73822020-10-27 04:36:22 +0100603 ``unicodedata.ucnhash_CAPI`` has been moved to the internal C API.
Victor Stinner920cb642020-10-26 19:19:36 +0100604 (Contributed by Victor Stinner in :issue:`42157`.)
Victor Stinner47e1afd2020-10-26 16:43:47 +0100605
Victor Stinnerace3f9a2020-11-10 21:10:22 +0100606* :c:func:`Py_GetPath`, :c:func:`Py_GetPrefix`, :c:func:`Py_GetExecPrefix`,
607 :c:func:`Py_GetProgramFullPath`, :c:func:`Py_GetPythonHome` and
608 :c:func:`Py_GetProgramName` functions now return ``NULL`` if called before
609 :c:func:`Py_Initialize` (before Python is initialized). Use the new
610 :ref:`Python Initialization Configuration API <init-config>` to get the
611 :ref:`Python Path Configuration. <init-path-config>`.
612 (Contributed by Victor Stinner in :issue:`42260`.)
613
Victor Stinner583ee5a2020-10-02 14:49:00 +0200614Deprecated
615----------
616
617* The ``PyUnicode_InternImmortal()`` function is now deprecated
618 and will be removed in Python 3.12: use :c:func:`PyUnicode_InternInPlace`
619 instead.
620 (Contributed by Victor Stinner in :issue:`41692`.)
621
Dong-hee Naad3252b2020-05-26 01:52:54 +0900622Removed
623-------
Inada Naoki6f8a6ee2020-06-26 08:07:22 +0900624
625* ``PyObject_AsCharBuffer()``, ``PyObject_AsReadBuffer()``, ``PyObject_CheckReadBuffer()``,
626 and ``PyObject_AsWriteBuffer()`` are removed. Please migrate to new buffer protocol;
627 :c:func:`PyObject_GetBuffer` and :c:func:`PyBuffer_Release`.
Inada Naoki20a79022020-06-27 18:22:09 +0900628 (Contributed by Inada Naoki in :issue:`41103`.)
629
630* Removed ``Py_UNICODE_str*`` functions manipulating ``Py_UNICODE*`` strings.
631 (Contributed by Inada Naoki in :issue:`41123`.)
632
633 * ``Py_UNICODE_strlen``: use :c:func:`PyUnicode_GetLength` or
634 :c:macro:`PyUnicode_GET_LENGTH`
635 * ``Py_UNICODE_strcat``: use :c:func:`PyUnicode_CopyCharacters` or
636 :c:func:`PyUnicode_FromFormat`
637 * ``Py_UNICODE_strcpy``, ``Py_UNICODE_strncpy``: use
638 :c:func:`PyUnicode_CopyCharacters` or :c:func:`PyUnicode_Substring`
639 * ``Py_UNICODE_strcmp``: use :c:func:`PyUnicode_Compare`
640 * ``Py_UNICODE_strncmp``: use :c:func:`PyUnicode_Tailmatch`
641 * ``Py_UNICODE_strchr``, ``Py_UNICODE_strrchr``: use
642 :c:func:`PyUnicode_FindChar`
Inada Naokid9f2a132020-06-29 10:46:51 +0900643
644* Removed ``PyUnicode_GetMax()``. Please migrate to new (:pep:`393`) APIs.
645 (Contributed by Inada Naoki in :issue:`41103`.)
Inada Naokie4f1fe62020-06-29 13:00:43 +0900646
647* Removed ``PyLong_FromUnicode()``. Please migrate to :c:func:`PyLong_FromUnicodeObject`.
648 (Contributed by Inada Naoki in :issue:`41103`.)
Inada Naokib3332662020-06-30 12:23:07 +0900649
650* Removed ``PyUnicode_AsUnicodeCopy()``. Please use :c:func:`PyUnicode_AsUCS4Copy` or
651 :c:func:`PyUnicode_AsWideCharString`
652 (Contributed by Inada Naoki in :issue:`41103`.)
Victor Stinner19c3ac92020-09-23 14:04:57 +0200653
654* Removed ``_Py_CheckRecursionLimit`` variable: it has been replaced by
655 ``ceval.recursion_limit`` of the :c:type:`PyInterpreterState` structure.
656 (Contributed by Victor Stinner in :issue:`41834`.)
Serhiy Storchakadcc54212020-10-05 12:32:00 +0300657
658* Removed undocumented macros ``Py_ALLOW_RECURSION`` and
659 ``Py_END_ALLOW_RECURSION`` and the ``recursion_critical`` field of the
660 :c:type:`PyInterpreterState` structure.
661 (Contributed by Serhiy Storchaka in :issue:`41936`.)
Victor Stinner296a7962020-11-17 16:22:23 +0100662
663* Removed the undocumented ``PyOS_InitInterrupts()`` function. Initializing
664 Python already implicitly installs signal handlers: see
665 :c:member:`PyConfig.install_signal_handlers`.
666 (Contributed by Victor Stinner in :issue:`41713`.)