blob: 25f71c4253d84c33a2de07ce8692971ab3260639 [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
Pablo Galindo7c8e0b02021-01-25 23:15:51 +000075Parenthesized context managers
76------------------------------
77
78Using enclosing parentheses for continuation across multiple lines
79in context managers is now supported. This allows formatting a long
80collection of context managers in multiple lines in a similar way
81as it was previously possible with import statements. For instance,
82all these examples are now valid:
83
84.. code-block:: python
85
86 with (CtxManager() as example):
87 ...
88
89 with (
90 CtxManager1(),
91 CtxManager2()
92 ):
93 ...
94
95 with (CtxManager1() as example,
96 CtxManager2()):
97 ...
98
99 with (CtxManager1(),
100 CtxManager2() as example):
101 ...
102
103 with (
104 CtxManager1() as example1,
105 CtxManager2() as example2
106 ):
107 ...
108
109it is also possible to use a trailing comma at the end of the
110enclosed group:
111
112.. code-block:: python
113
114 with (
115 CtxManager1() as example1,
116 CtxManager2() as example2,
117 CtxManager3() as example3,
118 ):
119 ...
120
121This new syntax uses the non LL(1) capacities of the new parser.
122Check :pep:`617` for more details.
123
124(Contributed by Guido van Rossum, Pablo Galindo and Lysandros Nikolaou
125in :issue:`12782` and :issue:`40334`.)
126
127
Ken Jin727a68b2021-03-03 08:52:03 +0800128Better error messages in the parser
129-----------------------------------
Batuhan Taskaya044a1042020-10-06 23:03:02 +0300130
Ken Jin727a68b2021-03-03 08:52:03 +0800131When parsing code that contains unclosed parentheses or brackets the interpreter
132now includes the location of the unclosed bracket of parentheses instead of displaying
133*SyntaxError: unexpected EOF while parsing* or pointing to some incorrect location.
134For instance, consider the following code (notice the unclosed '{'):
Batuhan Taskaya044a1042020-10-06 23:03:02 +0300135
Ken Jin727a68b2021-03-03 08:52:03 +0800136.. code-block:: python
Pablo Galindod4fe0982020-05-19 03:33:01 +0100137
Ken Jin727a68b2021-03-03 08:52:03 +0800138 expected = {9: 1, 18: 2, 19: 2, 27: 3, 28: 3, 29: 3, 36: 4, 37: 4,
139 38: 4, 39: 4, 45: 5, 46: 5, 47: 5, 48: 5, 49: 5, 54: 6,
140 some_other_code = foo()
Dennis Sweeney3ee0e482020-06-12 13:19:25 -0400141
Ken Jin727a68b2021-03-03 08:52:03 +0800142previous versions of the interpreter reported confusing places as the location of
143the syntax error:
Ram Rachum59cf8532020-06-19 23:39:22 +0300144
Ken Jin727a68b2021-03-03 08:52:03 +0800145.. code-block:: text
Mikhail Golubev4f3c2502020-10-08 00:44:31 +0300146
Ken Jin727a68b2021-03-03 08:52:03 +0800147 File "example.py", line 3
148 some_other_code = foo()
149 ^
150 SyntaxError: invalid syntax
Mikhail Golubev4f3c2502020-10-08 00:44:31 +0300151
Ken Jin727a68b2021-03-03 08:52:03 +0800152but in Python3.10 a more informative error is emitted:
Mikhail Golubev4f3c2502020-10-08 00:44:31 +0300153
Ken Jin727a68b2021-03-03 08:52:03 +0800154.. code-block:: text
Mikhail Golubev4f3c2502020-10-08 00:44:31 +0300155
Ken Jin727a68b2021-03-03 08:52:03 +0800156 File "example.py", line 1
157 expected = {9: 1, 18: 2, 19: 2, 27: 3, 28: 3, 29: 3, 36: 4, 37: 4,
158 ^
159 SyntaxError: '{' was never closed
Fidget-Spinner8e1dd552020-10-05 12:40:52 +0800160
161
Ken Jin727a68b2021-03-03 08:52:03 +0800162In a similar way, errors involving unclosed string literals (single and triple
163quoted) now point to the start of the string instead of reporting EOF/EOL.
Fidget-Spinner8e1dd552020-10-05 12:40:52 +0800164
Ken Jin727a68b2021-03-03 08:52:03 +0800165These improvements are inspired by previous work in the PyPy interpreter.
Fidget-Spinner8e1dd552020-10-05 12:40:52 +0800166
Ken Jin727a68b2021-03-03 08:52:03 +0800167(Contributed by Pablo Galindo in :issue:`42864` and Batuhan Taskaya in
168:issue:`40176`.)
Fidget-Spinner8e1dd552020-10-05 12:40:52 +0800169
Mark Shannon6086ae72021-03-16 13:43:58 +0000170PEP 626: Precise line numbers for debugging and other tools
171-----------------------------------------------------------
172
173PEP 626 brings more precise and reliable line numbers for debugging, profiling and coverage tools.
174Tracing events, with the correct line number, are generated for all lines of code executed and only for lines of code that are executed.
175
176The ``f_lineo`` attribute of frame objects will always contain the expected line number.
177
Ken Jin11276cd2021-01-02 08:45:50 +0800178
Carol Willing41934b32021-02-28 15:43:17 -0800179PEP 634: Structural Pattern Matching
180------------------------------------
181
182Structural pattern matching has been added in the form of a *match statement*
183and *case statements* of patterns with associated actions. Patterns
184consist of sequences, mappings, primitive data types as well as class instances.
185Pattern matching enables programs to extract information from complex data types,
186branch on the structure of data, and apply specific actions based on different
187forms of data.
188
189Syntax and operations
190~~~~~~~~~~~~~~~~~~~~~
191
192The generic syntax of pattern matching is::
193
194 match subject:
195 case <pattern_1>:
196 <action_1>
197 case <pattern_2>:
198 <action_2>
199 case <pattern_3>:
200 <action_3>
201 case _:
202 <action_wildcard>
203
204A match statement takes an expression and compares its value to successive
205patterns given as one or more case blocks. Specifically, pattern matching
206operates by:
207
208 1. using data with type and shape (the ``subject``)
209 2. evaluating the ``subject`` in the ``match`` statement
210 3. comparing the subject with each pattern in a ``case`` statement
211 from top to bottom until a match is confirmed.
212 4. executing the action associated with the pattern of the confirmed
213 match
214 5. If an exact match is not confirmed, the last case, a wildcard ``_``,
215 if provided, will be used as the matching case. If an exact match is
216 not confirmed and a wildcard case does not exists, the entire match
217 block is a no-op.
218
219Declarative approach
220~~~~~~~~~~~~~~~~~~~~
221
222Readers may be aware of pattern matching through the simple example of matching
223a subject (data object) to a literal (pattern) with the switch statement found
224in C, Java or JavaScript (and many other languages). Often the switch statement
225is used for comparison of an object/expression with case statements containing
226literals.
227
228More powerful examples of pattern matching can be found in languages, such as
229Scala and Elixir. With structural pattern matching, the approach is "declarative" and
230explicitly states the conditions (the patterns) for data to match.
231
232While an "imperative" series of instructions using nested "if" statements
233could be used to accomplish something similar to structural pattern matching,
234it is less clear than the "declarative" approach. Instead the "declarative"
235approach states the conditions to meet for a match and is more readable through
236its explicit patterns. While structural pattern matching can be used in its
237simplest form comparing a variable to a literal in a case statement, its
238true value for Python lies in its handling of the subject's type and shape.
239
240Simple pattern: match to a literal
241~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
242
243Let's look at this example as pattern matching in its simplest form: a value,
244the subject, being matched to several literals, the patterns. In the example
245below, ``status`` is the subject of the match statement. The patterns are
246each of the case statements, where literals represent request status codes.
247The associated action to the case is executed after a match::
248
249 def http_error(status):
250 match status:
251 case 400:
252 return "Bad request"
253 case 404:
254 return "Not found"
255 case 418:
256 return "I'm a teapot"
257 case _:
258 return "Something's wrong with the Internet"
259
260If the above function is passed a ``status`` of 418, "I'm a teapot" is returned.
261If the above function is passed a ``status`` of 500, the case statement with
262``_`` will match as a wildcard, and "Something's wrong with the Internet" is
263returned.
264Note the last block: the variable name, ``_``, acts as a *wildcard* and insures
265the subject will always match. The use of ``_`` is optional.
266
267You can combine several literals in a single pattern using ``|`` ("or")::
268
269 case 401 | 403 | 404:
270 return "Not allowed"
271
272Behavior without the wildcard
273^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
274
275If we modify the above example by removing the last case block, the example
276becomes::
277
278 def http_error(status):
279 match status:
280 case 400:
281 return "Bad request"
282 case 404:
283 return "Not found"
284 case 418:
285 return "I'm a teapot"
286
287Without the use of ``_`` in a case statement, a match may not exist. If no
288match exists, the behavior is a no-op. For example, if ``status`` of 500 is
289passed, a no-op occurs.
290
Julien Palardb04f1cb2021-03-03 11:32:12 +0100291Patterns with a literal and variable
292~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Carol Willing41934b32021-02-28 15:43:17 -0800293
294Patterns can look like unpacking assignments, and a pattern may be used to bind
295variables. In this example, a data point can be unpacked to its x-coordinate
296and y-coordinate::
297
298 # point is an (x, y) tuple
299 match point:
300 case (0, 0):
301 print("Origin")
302 case (0, y):
303 print(f"Y={y}")
304 case (x, 0):
305 print(f"X={x}")
306 case (x, y):
307 print(f"X={x}, Y={y}")
308 case _:
309 raise ValueError("Not a point")
310
311The first pattern has two literals, ``(0, 0)``, and may be thought of as an
312extension of the literal pattern shown above. The next two patterns combine a
313literal and a variable, and the variable *binds* a value from the subject
314(``point``). The fourth pattern captures two values, which makes it
315conceptually similar to the unpacking assignment ``(x, y) = point``.
316
317Patterns and classes
318~~~~~~~~~~~~~~~~~~~~
319
320If you are using classes to structure your data, you can use as a pattern
321the class name followed by an argument list resembling a constructor. This
322pattern has the ability to capture class attributes into variables::
323
324 class Point:
325 x: int
326 y: int
327
328 def location(point):
329 match point:
330 case Point(x=0, y=0):
331 print("Origin is the point's location.")
332 case Point(x=0, y=y):
333 print(f"Y={y} and the point is on the y-axis.")
334 case Point(x=x, y=0):
335 print(f"X={x} and the point is on the x-axis.")
336 case Point():
337 print("The point is located somewhere else on the plane.")
338 case _:
339 print("Not a point")
340
341Patterns with positional parameters
342^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
343
344You can use positional parameters with some builtin classes that provide an
345ordering for their attributes (e.g. dataclasses). You can also define a specific
346position for attributes in patterns by setting the ``__match_args__`` special
347attribute in your classes. If it's set to ("x", "y"), the following patterns
348are all equivalent (and all bind the ``y`` attribute to the ``var`` variable)::
349
350 Point(1, var)
351 Point(1, y=var)
352 Point(x=1, y=var)
353 Point(y=var, x=1)
354
355Nested patterns
356~~~~~~~~~~~~~~~
357
358Patterns can be arbitrarily nested. For example, if our data is a short
359list of points, it could be matched like this::
360
361 match points:
362 case []:
363 print("No points in the list.")
364 case [Point(0, 0)]:
365 print("The origin is the only point in the list.")
366 case [Point(x, y)]:
367 print(f"A single point {x}, {y} is in the list.")
368 case [Point(0, y1), Point(0, y2)]:
369 print(f"Two points on the Y axis at {y1}, {y2} are in the list.")
370 case _:
371 print("Something else is found in the list.")
372
373Complex patterns and the wildcard
374~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
375
376To this point, the examples have used ``_`` alone in the last case statement.
377A wildcard can be used in more complex patterns, such as ``('error', code, _)``.
378For example::
379
380 match test_variable:
381 case ('warning', code, 40):
382 print("A warning has been received.")
383 case ('error', code, _):
384 print(f"An error {code} occured.")
385
386In the above case, ``test_variable`` will match for ('error', code, 100) and
387('error', code, 800).
388
389Guard
390~~~~~
391
392We can add an ``if`` clause to a pattern, known as a "guard". If the
393guard is false, ``match`` goes on to try the next case block. Note
394that value capture happens before the guard is evaluated::
395
396 match point:
397 case Point(x, y) if x == y:
398 print(f"The point is located on the diagonal Y=X at {x}.")
399 case Point(x, y):
400 print(f"Point is not on the diagonal.")
401
402Other Key Features
403~~~~~~~~~~~~~~~~~~
404
405Several other key features:
406
407- Like unpacking assignments, tuple and list patterns have exactly the
408 same meaning and actually match arbitrary sequences. Technically,
409 the subject must be an instance of ``collections.abc.Sequence``.
410 Therefore, an important exception is that patterns don't match iterators.
411 Also, to prevent a common mistake, sequence patterns don't match strings.
412
413- Sequence patterns support wildcards: ``[x, y, *rest]`` and ``(x, y,
414 *rest)`` work similar to wildcards in unpacking assignments. The
415 name after ``*`` may also be ``_``, so ``(x, y, *_)`` matches a sequence
416 of at least two items without binding the remaining items.
417
418- Mapping patterns: ``{"bandwidth": b, "latency": l}`` captures the
419 ``"bandwidth"`` and ``"latency"`` values from a dict. Unlike sequence
420 patterns, extra keys are ignored. A wildcard ``**rest`` is also
421 supported. (But ``**_`` would be redundant, so it not allowed.)
422
423- Subpatterns may be captured using the ``as`` keyword::
424
425 case (Point(x1, y1), Point(x2, y2) as p2): ...
426
427 This binds x1, y1, x2, y2 like you would expect without the ``as`` clause,
428 and p2 to the entire second item of the subject.
429
430- Most literals are compared by equality. However, the singletons ``True``,
431 ``False`` and ``None`` are compared by identity.
432
433- Named constants may be used in patterns. These named constants must be
434 dotted names to prevent the constant from being interpreted as a capture
435 variable::
436
437 from enum import Enum
438 class Color(Enum):
439 RED = 0
440 GREEN = 1
441 BLUE = 2
442
443 match color:
444 case Color.RED:
445 print("I see red!")
446 case Color.GREEN:
447 print("Grass is green")
448 case Color.BLUE:
449 print("I'm feeling the blues :(")
450
451For the full specification see :pep:`634`. Motivation and rationale
452are in :pep:`635`, and a longer tutorial is in :pep:`636`.
453
Pablo Galindo805ede82021-01-21 17:36:35 +0000454
Ken Jin727a68b2021-03-03 08:52:03 +0800455New Features Related to Type Annotations
456========================================
Pablo Galindo805ede82021-01-21 17:36:35 +0000457
Ken Jin727a68b2021-03-03 08:52:03 +0800458This section covers major changes affecting :pep:`484` type annotations and
459the :mod:`typing` module.
Pablo Galindo805ede82021-01-21 17:36:35 +0000460
461
Ken Jin727a68b2021-03-03 08:52:03 +0800462PEP 563: Postponed Evaluation of Annotations Becomes Default
463------------------------------------------------------------
Pablo Galindo805ede82021-01-21 17:36:35 +0000464
Ken Jin727a68b2021-03-03 08:52:03 +0800465In Python 3.7, postponed evaluation of annotations was added,
466to be enabled with a ``from __future__ import annotations``
467directive. In 3.10 this became the default behavior, even
468without that future directive. With this being default, all
469annotations stored in :attr:`__annotations__` will be strings.
470If needed, annotations can be resolved at runtime using
471:func:`typing.get_type_hints`. See :pep:`563` for a full
472description. Also, the :func:`inspect.signature` will try to
473resolve types from now on, and when it fails it will fall back to
474showing the string annotations. (Contributed by Batuhan Taskaya
475in :issue:`38605`.)
Pablo Galindo805ede82021-01-21 17:36:35 +0000476
Ken Jin727a68b2021-03-03 08:52:03 +0800477
478PEP 604: New Type Union Operator
479--------------------------------
480
481A new type union operator was introduced which enables the syntax ``X | Y``.
482This provides a cleaner way of expressing 'either type X or type Y' instead of
483using :data:`typing.Union`, especially in type hints (annotations).
484
485In previous versions of Python, to apply a type hint for functions accepting
486arguments of multiple types, :data:`typing.Union` was used::
487
488 def square(number: Union[int, float]) -> Union[int, float]:
489 return number ** 2
490
491
492Type hints can now be written in a more succinct manner::
493
494 def square(number: int | float) -> int | float:
495 return number ** 2
496
497
498This new syntax is also accepted as the second argument to :func:`isinstance`
499and :func:`issubclass`::
500
501 >>> isinstance(1, int | str)
502 True
503
504See :ref:`types-union` and :pep:`604` for more details.
505
506(Contributed by Maggie Moss and Philippe Prados in :issue:`41428`.)
507
508
509PEP 612: Parameter Specification Variables
510------------------------------------------
511
512Two new options to improve the information provided to static type checkers for
513:pep:`484`\ 's ``Callable`` have been added to the :mod:`typing` module.
514
515The first is the parameter specification variable. They are used to forward the
516parameter types of one callable to another callable -- a pattern commonly
517found in higher order functions and decorators. Examples of usage can be found
518in :class:`typing.ParamSpec`. Previously, there was no easy way to type annotate
519dependency of parameter types in such a precise manner.
520
521The second option is the new ``Concatenate`` operator. It's used in conjunction
522with parameter specification variables to type annotate a higher order callable
523which adds or removes parameters of another callable. Examples of usage can
524be found in :class:`typing.Concatenate`.
525
526See :class:`typing.Callable`, :class:`typing.ParamSpec`,
527:class:`typing.Concatenate` and :pep:`612` for more details.
528
529(Contributed by Ken Jin in :issue:`41559`.)
530
531
532PEP 613: TypeAlias Annotation
533-----------------------------
534
535:pep:`484` introduced the concept of type aliases, only requiring them to be
536top-level unannotated assignments. This simplicity sometimes made it difficult
537for type checkers to distinguish between type aliases and ordinary assignments,
538especially when forward references or invalid types were involved. Compare::
539
540 StrCache = 'Cache[str]' # a type alias
541 LOG_PREFIX = 'LOG[DEBUG]' # a module constant
542
543Now the :mod:`typing` module has a special annotation :data:`TypeAlias` to
544declare type aliases more explicitly::
545
546 StrCache: TypeAlias = 'Cache[str]' # a type alias
547 LOG_PREFIX = 'LOG[DEBUG]' # a module constant
548
549See :pep:`613` for more details.
550
551(Contributed by Mikhail Golubev in :issue:`41923`.)
552
Pablo Galindo805ede82021-01-21 17:36:35 +0000553
Pablo Galindod4fe0982020-05-19 03:33:01 +0100554Other Language Changes
555======================
556
Ken Jin727a68b2021-03-03 08:52:03 +0800557* The :class:`int` type has a new method :meth:`int.bit_count`, returning the
558 number of ones in the binary expansion of a given integer, also known
559 as the population count. (Contributed by Niklas Fiekas in :issue:`29882`.)
560
561* The views returned by :meth:`dict.keys`, :meth:`dict.values` and
562 :meth:`dict.items` now all have a ``mapping`` attribute that gives a
563 :class:`types.MappingProxyType` object wrapping the original
564 dictionary. (Contributed by Dennis Sweeney in :issue:`40890`.)
565
566* :pep:`618`: The :func:`zip` function now has an optional ``strict`` flag, used
567 to require that all the iterables have an equal length.
568
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300569* Builtin and extension functions that take integer arguments no longer accept
570 :class:`~decimal.Decimal`\ s, :class:`~fractions.Fraction`\ s and other
571 objects that can be converted to integers only with a loss (e.g. that have
572 the :meth:`~object.__int__` method but do not have the
573 :meth:`~object.__index__` method).
574 (Contributed by Serhiy Storchaka in :issue:`37999`.)
Ken Jin727a68b2021-03-03 08:52:03 +0800575
Alexcc02b4f2021-02-26 21:58:39 +0200576* If :func:`object.__ipow__` returns :const:`NotImplemented`, the operator will
577 correctly fall back to :func:`object.__pow__` and :func:`object.__rpow__` as expected.
578 (Contributed by Alex Shkop in :issue:`38302`.)
Pablo Galindod4fe0982020-05-19 03:33:01 +0100579
Lysandros Nikolaoua85fefe2020-11-19 01:49:28 +0200580* Assignment expressions can now be used unparenthesized within set literals
581 and set comprehensions, as well as in sequence indexes (but not slices).
582
Victor Stinnera3c3ffa2021-02-18 12:35:37 +0100583* Functions have a new ``__builtins__`` attribute which is used to look for
584 builtin symbols when a function is executed, instead of looking into
Victor Stinner46496f92021-02-20 15:17:18 +0100585 ``__globals__['__builtins__']``. The attribute is initialized from
586 ``__globals__["__builtins__"]`` if it exists, else from the current builtins.
Victor Stinnera3c3ffa2021-02-18 12:35:37 +0100587 (Contributed by Mark Shannon in :issue:`42990`.)
588
Pablo Galindod4fe0982020-05-19 03:33:01 +0100589
590New Modules
591===========
592
593* None yet.
594
595
596Improved Modules
597================
598
Tomáš Hrnčiarfb35fa42021-01-12 01:41:35 +0100599argparse
600--------
601
602Misleading phrase "optional arguments" was replaced with "options" in argparse help. Some tests might require adaptation if they rely on exact output match.
603(Contributed by Raymond Hettinger in :issue:`9694`.)
604
Filipe Laíns4ce6faa2020-08-10 15:48:20 +0100605base64
606------
607
608Add :func:`base64.b32hexencode` and :func:`base64.b32hexdecode` to support the
609Base32 Encoding with Extended Hex Alphabet.
610
Hai Shid332e7b2020-09-29 05:41:11 +0800611codecs
612------
613
614Add a :func:`codecs.unregister` function to unregister a codec search function.
615(Contributed by Hai Shi in :issue:`41842`.)
616
kjd75f6f72020-12-19 01:39:26 +0800617collections.abc
618---------------
619
620The ``__args__`` of the :ref:`parameterized generic <types-genericalias>` for
621:class:`collections.abc.Callable` are now consistent with :data:`typing.Callable`.
622:class:`collections.abc.Callable` generic now flattens type parameters, similar
623to what :data:`typing.Callable` currently does. This means that
624``collections.abc.Callable[[int, str], str]`` will have ``__args__`` of
625``(int, str, str)``; previously this was ``([int, str], str)``. To allow this
626change, :class:`types.GenericAlias` can now be subclassed, and a subclass will
627be returned when subscripting the :class:`collections.abc.Callable` type. Note
628that a :exc:`TypeError` may be raised for invalid forms of parameterizing
629:class:`collections.abc.Callable` which may have passed silently in Python 3.9.
630(Contributed by Ken Jin in :issue:`42195`.)
631
Joongi Kim3eb28462020-11-11 00:19:11 +0900632contextlib
633----------
634
635Add a :func:`contextlib.aclosing` context manager to safely close async generators
636and objects representing asynchronously released resources.
637(Contributed by Joongi Kim and John Belmonte in :issue:`41229`.)
638
Tom Gringauz9c98e8c2020-11-18 00:58:35 +0200639Add asynchronous context manager support to :func:`contextlib.nullcontext`.
640(Contributed by Tom Gringauz in :issue:`41543`.)
641
Hans Petter Janssonda4e09f2020-08-03 22:51:33 -0500642curses
643------
644
645The extended color functions added in ncurses 6.1 will be used transparently
646by :func:`curses.color_content`, :func:`curses.init_color`,
647:func:`curses.init_pair`, and :func:`curses.pair_content`. A new function,
648:func:`curses.has_extended_color_support`, indicates whether extended color
649support is provided by the underlying ncurses library.
650(Contributed by Jeffrey Kintscher and Hans Petter Jansson in :issue:`36982`.)
651
Zackery Spytz14cfa322021-01-14 02:40:09 -0700652The ``BUTTON5_*`` constants are now exposed in the :mod:`curses` module if
653they are provided by the underlying curses library.
654(Contributed by Zackery Spytz in :issue:`39273`.)
655
Steve Dower62949f62021-01-29 21:48:55 +0000656.. _distutils-deprecated:
657
Victor Stinner0e2a0f72021-01-09 00:35:01 +0100658distutils
659---------
660
Steve Dower62949f62021-01-29 21:48:55 +0000661The entire ``distutils`` package is deprecated, to be removed in Python
6623.12. Its functionality for specifying package builds has already been
663completely replaced by third-party packages ``setuptools`` and
664``packaging``, and most other commonly used APIs are available elsewhere
665in the standard library (such as :mod:`platform`, :mod:`shutil`,
666:mod:`subprocess` or :mod:`sysconfig`). There are no plans to migrate
667any other functionality from ``distutils``, and applications that are
668using other functions should plan to make private copies of the code.
669Refer to :pep:`632` for discussion.
670
Victor Stinner0e2a0f72021-01-09 00:35:01 +0100671The ``bdist_wininst`` command deprecated in Python 3.8 has been removed.
ravcio6cd5b012021-01-21 11:23:46 +0100672The ``bdist_wheel`` command is now recommended to distribute binary packages
Victor Stinner0e2a0f72021-01-09 00:35:01 +0100673on Windows.
674(Contributed by Victor Stinner in :issue:`42802`.)
675
Brett Cannon825ac382020-11-06 18:45:56 -0800676doctest
677-------
678
679When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
680(Contributed by Brett Cannon in :issue:`42133`.)
681
Hai Shic5b049b2020-10-14 23:43:31 +0800682encodings
683---------
Pablo Galindob4f90892021-03-10 00:53:57 +0000684
Hai Shic5b049b2020-10-14 23:43:31 +0800685:func:`encodings.normalize_encoding` now ignores non-ASCII characters.
686(Contributed by Hai Shi in :issue:`39337`.)
687
Pablo Galindob4f90892021-03-10 00:53:57 +0000688gc
689--
690
691Added audit hooks for :func:`gc.get_objects`, :func:`gc.get_referrers` and
692:func:`gc.get_referents`. (Contributed by Pablo Galindo in :issue:`43439`.)
693
Serhiy Storchaka8a64cea2020-06-18 22:08:27 +0300694glob
695----
696
697Added the *root_dir* and *dir_fd* parameters in :func:`~glob.glob` and
698:func:`~glob.iglob` which allow to specify the root directory for searching.
699(Contributed by Serhiy Storchaka in :issue:`38144`.)
700
Jason R. Coombs35d50682021-03-14 22:20:49 -0400701importlib.metadata
702------------------
703
704Feature parity with ``importlib_metadata`` 3.7.
705
706:func:`importlib.metadata.entry_points` now provides a nicer experience
707for selecting entry points by group and name through a new
708:class:`importlib.metadata.EntryPoints` class.
709
710Added :func:`importlib.metadata.packages_distributions` for resolving
711top-level Python modules and packages to their
712:class:`importlib.metadata.Distribution`.
713
Brett Cannon825ac382020-11-06 18:45:56 -0800714inspect
715-------
716
717When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
718(Contributed by Brett Cannon in :issue:`42133`.)
719
Batuhan Taskayaeee1c772020-12-24 01:45:13 +0300720Added *globalns* and *localns* parameters in :func:`~inspect.signature` and
721:meth:`inspect.Signature.from_callable` to retrieve the annotations in given
722local and global namespaces.
723(Contributed by Batuhan Taskaya in :issue:`41960`.)
724
Brett Cannon825ac382020-11-06 18:45:56 -0800725linecache
726---------
727
728When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
729(Contributed by Brett Cannon in :issue:`42133`.)
730
pxinwr3405e052020-08-07 13:21:52 +0800731os
732--
733
734Added :func:`os.cpu_count()` support for VxWorks RTOS.
735(Contributed by Peixing Xin in :issue:`41440`.)
736
Christian Heimescd9fed62020-11-13 19:48:52 +0100737Added a new function :func:`os.eventfd` and related helpers to wrap the
738``eventfd2`` syscall on Linux.
739(Contributed by Christian Heimes in :issue:`41001`.)
740
Pablo Galindoa57b3d32020-11-17 00:00:38 +0000741Added :func:`os.splice()` that allows to move data between two file
742descriptors without copying between kernel address space and user
743address space, where one of the file descriptors must refer to a
744pipe. (Contributed by Pablo Galindo in :issue:`41625`.)
745
Dong-hee Naf917c242021-02-04 08:32:55 +0900746Added :data:`~os.O_EVTONLY`, :data:`~os.O_FSYNC`, :data:`~os.O_SYMLINK`
747and :data:`~os.O_NOFOLLOW_ANY` for macOS.
748(Contributed by Dong-hee Na in :issue:`43106`.)
749
Joshua Cannon45205842020-11-20 09:40:39 -0600750pathlib
751-------
752
Yaroslav Pankovych79d2e622020-11-23 22:06:22 +0200753Added slice support to :attr:`PurePath.parents <pathlib.PurePath.parents>`.
Joshua Cannon45205842020-11-20 09:40:39 -0600754(Contributed by Joshua Cannon in :issue:`35498`)
755
Yaroslav Pankovych79d2e622020-11-23 22:06:22 +0200756Added negative indexing support to :attr:`PurePath.parents
757<pathlib.PurePath.parents>`.
758(Contributed by Yaroslav Pankovych in :issue:`21041`)
759
Christian Heimes5c73afc2020-11-30 22:34:45 +0100760platform
761--------
762
763Added :func:`platform.freedesktop_os_release()` to retrieve operation system
764identification from `freedesktop.org os-release
765<https://www.freedesktop.org/software/systemd/man/os-release.html>`_ standard file.
766(Contributed by Christian Heimes in :issue:`28468`)
767
Gregory Schevchenkodaff3902020-07-25 22:58:45 +0300768py_compile
769----------
770
771Added ``--quiet`` option to command-line interface of :mod:`py_compile`.
772(Contributed by Gregory Schevchenko in :issue:`38731`.)
773
Aviral Srivastava000cde52021-02-01 09:38:44 -0800774pyclbr
775------
776
777Added an ``end_lineno`` attribute to the ``Function`` and ``Class``
778objects in the tree returned by :func:`pyclbr.readline` and
779:func:`pyclbr.readline_ex`. It matches the existing (start) ``lineno``.
780(Contributed by Aviral Srivastava in :issue:`38307`.)
781
Zackery Spytzdf592732020-10-29 03:44:35 -0600782shelve
783------
784
785The :mod:`shelve` module now uses :data:`pickle.DEFAULT_PROTOCOL` by default
786instead of :mod:`pickle` protocol ``3`` when creating shelves.
787(Contributed by Zackery Spytz in :issue:`34204`.)
788
Brett Cannon825ac382020-11-06 18:45:56 -0800789site
790----
791
792When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
793(Contributed by Brett Cannon in :issue:`42133`.)
794
Christian Heimes03c8ddd2020-11-20 09:26:07 +0100795socket
796------
797
798The exception :exc:`socket.timeout` is now an alias of :exc:`TimeoutError`.
799(Contributed by Christian Heimes in :issue:`42413`.)
800
Victor Stinnerdd8a93e2020-06-30 00:49:03 +0200801sys
802---
803
804Add :data:`sys.orig_argv` attribute: the list of the original command line
805arguments passed to the Python executable.
806(Contributed by Victor Stinner in :issue:`23427`.)
807
Victor Stinner9852cb32021-01-25 23:12:50 +0100808Add :data:`sys.stdlib_module_names`, containing the list of the standard library
Victor Stinnerdb584bd2021-01-25 13:24:42 +0100809module names.
810(Contributed by Victor Stinner in :issue:`42955`.)
811
Antoine Pitrouba251c22021-03-11 23:35:45 +0100812_thread
813-------
814
815:func:`_thread.interrupt_main` now takes an optional signal number to
816simulate (the default is still :data:`signal.SIGINT`).
817(Contributed by Antoine Pitrou in :issue:`43356`.)
818
Mario Corchero0001a1b2020-11-04 10:27:43 +0100819threading
820---------
821
822Added :func:`threading.gettrace` and :func:`threading.getprofile` to
823retrieve the functions set by :func:`threading.settrace` and
824:func:`threading.setprofile` respectively.
825(Contributed by Mario Corchero in :issue:`42251`.)
826
Mario Corchero750c5ab2020-11-12 18:27:44 +0100827Add :data:`threading.__excepthook__` to allow retrieving the original value
828of :func:`threading.excepthook` in case it is set to a broken or a different
829value.
830(Contributed by Mario Corchero in :issue:`42308`.)
831
Zackery Spytz91e93792020-11-05 15:18:44 -0700832traceback
833---------
834
835The :func:`~traceback.format_exception`,
836:func:`~traceback.format_exception_only`, and
837:func:`~traceback.print_exception` functions can now take an exception object
838as a positional-only argument.
839(Contributed by Zackery Spytz and Matthias Bussonnier in :issue:`26389`.)
840
Bas van Beek0d0e9fe2020-09-22 17:55:34 +0200841types
842-----
843
844Reintroduced the :data:`types.EllipsisType`, :data:`types.NoneType`
845and :data:`types.NotImplementedType` classes, providing a new set
846of types readily interpretable by type checkers.
847(Contributed by Bas van Beek in :issue:`41810`.)
848
kj46873382020-11-19 11:44:24 +0700849typing
850------
851
Ken Jin727a68b2021-03-03 08:52:03 +0800852For major changes, see `New Features Related to Type Annotations`_.
853
kj46873382020-11-19 11:44:24 +0700854The behavior of :class:`typing.Literal` was changed to conform with :pep:`586`
855and to match the behavior of static type checkers specified in the PEP.
856
8571. ``Literal`` now de-duplicates parameters.
8582. Equality comparisons between ``Literal`` objects are now order independent.
8593. ``Literal`` comparisons now respects types. For example,
860 ``Literal[0] == Literal[False]`` previously evaluated to ``True``. It is
861 now ``False``. To support this change, the internally used type cache now
862 supports differentiating types.
8634. ``Literal`` objects will now raise a :exc:`TypeError` exception during
864 equality comparisons if one of their parameters are not :term:`immutable`.
865 Note that declaring ``Literal`` with mutable parameters will not throw
866 an error::
867
868 >>> from typing import Literal
869 >>> Literal[{0}]
870 >>> Literal[{0}] == Literal[{False}]
871 Traceback (most recent call last):
872 File "<stdin>", line 1, in <module>
873 TypeError: unhashable type: 'set'
874
875(Contributed by Yurii Karabas in :issue:`42345`.)
876
Mark Dickinsonc8c70e72020-09-19 21:38:11 +0100877unittest
878--------
879
880Add new method :meth:`~unittest.TestCase.assertNoLogs` to complement the
881existing :meth:`~unittest.TestCase.assertLogs`. (Contributed by Kit Yan Choi
882in :issue:`39385`.)
883
Adam Goldschmidtfcbe0cb2021-02-15 00:41:57 +0200884urllib.parse
885------------
886
887Python versions earlier than Python 3.10 allowed using both ``;`` and ``&`` as
888query parameter separators in :func:`urllib.parse.parse_qs` and
889:func:`urllib.parse.parse_qsl`. Due to security concerns, and to conform with
890newer W3C recommendations, this has been changed to allow only a single
891separator key, with ``&`` as the default. This change also affects
892:func:`cgi.parse` and :func:`cgi.parse_multipart` as they use the affected
893functions internally. For more details, please see their respective
894documentation.
895(Contributed by Adam Goldschmidt, Senthil Kumaran and Ken Jin in :issue:`42967`.)
896
Zackery Spytze28b8c92020-08-09 04:50:53 -0600897xml
898---
899
900Add a :class:`~xml.sax.handler.LexicalHandler` class to the
901:mod:`xml.sax.handler` module.
902(Contributed by Jonathan Gossage and Zackery Spytz in :issue:`35018`.)
903
Brett Cannond2e94bb2020-11-13 15:14:58 -0800904zipimport
905---------
906Add methods related to :pep:`451`: :meth:`~zipimport.zipimporter.find_spec`,
907:meth:`zipimport.zipimporter.create_module`, and
908:meth:`zipimport.zipimporter.exec_module`.
909(Contributed by Brett Cannon in :issue:`42131`.
910
Serhiy Storchaka8a64cea2020-06-18 22:08:27 +0300911
Pablo Galindod4fe0982020-05-19 03:33:01 +0100912Optimizations
913=============
914
Serhiy Storchaka12f43342020-07-20 15:53:55 +0300915* Constructors :func:`str`, :func:`bytes` and :func:`bytearray` are now faster
916 (around 30--40% for small objects).
917 (Contributed by Serhiy Storchaka in :issue:`41334`.)
918
Victor Stinner2c2a4f32020-06-18 01:20:51 +0200919* The :mod:`runpy` module now imports fewer modules.
Victor Stinner4c18fc82020-06-17 23:58:58 +0200920 The ``python3 -m module-name`` command startup time is 1.3x faster in
921 average.
922 (Contributed by Victor Stinner in :issue:`41006`.)
923
Pablo Galindo9e8fe192021-01-03 04:37:46 +0000924* The ``LOAD_ATTR`` instruction now uses new "per opcode cache" mechanism. It
Pablo Galindoa776da92021-01-31 22:55:48 +0000925 is about 36% faster now for regular attributes and 44% faster for slots.
926 (Contributed by Pablo Galindo and Yury Selivanov in :issue:`42093` and Guido
927 van Rossum in :issue:`42927`, based on ideas implemented originally in PyPy
928 and MicroPython.)
Pablo Galindod4fe0982020-05-19 03:33:01 +0100929
Pablo Galindob451b0e2020-10-21 22:46:52 +0100930* When building Python with ``--enable-optimizations`` now
931 ``-fno-semantic-interposition`` is added to both the compile and link line.
932 This speeds builds of the Python interpreter created with ``--enable-shared``
933 with ``gcc`` by up to 30%. See `this article
934 <https://developers.redhat.com/blog/2020/06/25/red-hat-enterprise-linux-8-2-brings-faster-python-3-8-run-speeds/>`_
935 for more details. (Contributed by Victor Stinner and Pablo Galindo in
Brett Cannon2de50972020-12-04 15:39:21 -0800936 :issue:`38980`.)
937
Pablo Galindob451b0e2020-10-21 22:46:52 +0100938
Yurii Karabas73019792020-11-25 12:43:18 +0200939* Function parameters and their annotations are no longer computed at runtime,
940 but rather at compilation time. They are stored as a tuple of strings at the
Pablo Galindo8747c1f2021-03-04 01:29:29 +0000941 bytecode level. It is now around 2 times faster to create a function with
942 parameter annotations. (Contributed by Yurii Karabas and Inada Naoki
943 in :issue:`42202`)
Yurii Karabas73019792020-11-25 12:43:18 +0200944
Dennis Sweeneye8f5ddd2021-02-28 16:32:04 -0500945* Substring search functions such as ``str1 in str2`` and ``str2.find(str1)``
946 now sometimes use Crochemore & Perrin's "Two-Way" string searching
947 algorithm to avoid quadratic behavior on long strings. (Contributed
948 by Dennis Sweeney in :issue:`41972`)
949
Pablo Galindod4fe0982020-05-19 03:33:01 +0100950Deprecated
951==========
952
Brett Cannon04523c52020-10-23 18:10:54 -0700953* Starting in this release, there will be a concerted effort to begin
954 cleaning up old import semantics that were kept for Python 2.7
955 compatibility. Specifically,
956 :meth:`~importlib.abc.PathEntryFinder.find_loader`/:meth:`~importlib.abc.Finder.find_module`
957 (superseded by :meth:`~importlib.abc.Finder.find_spec`),
958 :meth:`~importlib.abc.Loader.load_module`
959 (superseded by :meth:`~importlib.abc.Loader.exec_module`),
960 :meth:`~importlib.abc.Loader.module_repr` (which the import system
961 takes care of for you), the ``__package__`` attribute
962 (superseded by ``__spec__.parent``), the ``__loader__`` attribute
963 (superseded by ``__spec__.loader``), and the ``__cached__`` attribute
964 (superseded by ``__spec__.cached``) will slowly be removed (as well
965 as other classes and methods in :mod:`importlib`).
966 :exc:`ImportWarning` and/or :exc:`DeprecationWarning` will be raised
967 as appropriate to help identify code which needs updating during
968 this transition.
969
Steve Dower62949f62021-01-29 21:48:55 +0000970* The entire ``distutils`` namespace is deprecated, to be removed in
971 Python 3.12. Refer to the :ref:`module changes <distutils-deprecated>`
972 section for more information.
973
Serhiy Storchakaf066bd92021-01-25 23:02:04 +0200974* Non-integer arguments to :func:`random.randrange` are deprecated.
975 The :exc:`ValueError` is deprecated in favor of a :exc:`TypeError`.
976 (Contributed by Serhiy Storchaka and Raymond Hettinger in :issue:`37319`.)
977
Brett Cannon2de50972020-12-04 15:39:21 -0800978* The various ``load_module()`` methods of :mod:`importlib` have been
979 documented as deprecated since Python 3.6, but will now also trigger
980 a :exc:`DeprecationWarning`. Use
981 :meth:`~importlib.abc.Loader.exec_module` instead.
982 (Contributed by Brett Cannon in :issue:`26131`.)
983
984* :meth:`zimport.zipimporter.load_module` has been deprecated in
985 preference for :meth:`~zipimport.zipimporter.exec_module`.
986 (Contributed by Brett Cannon in :issue:`26131`.)
987
988* The use of :meth:`~importlib.abc.Loader.load_module` by the import
989 system now triggers an :exc:`ImportWarning` as
990 :meth:`~importlib.abc.Loader.exec_module` is preferred.
991 (Contributed by Brett Cannon in :issue:`26131`.)
992
Erlend Egeberg Aaslanda1f401a2020-11-17 16:55:12 +0100993* ``sqlite3.OptimizedUnicode`` has been undocumented and obsolete since Python
994 3.3, when it was made an alias to :class:`str`. It is now deprecated,
995 scheduled for removal in Python 3.12.
996 (Contributed by Erlend E. Aasland in :issue:`42264`.)
997
Erlend Egeberg Aaslandddb5e112021-01-06 01:36:04 +0100998* The undocumented built-in function ``sqlite3.enable_shared_cache`` is now
999 deprecated, scheduled for removal in Python 3.12. Its use is strongly
1000 discouraged by the SQLite3 documentation. See `the SQLite3 docs
Tom Forbes749d40a2021-02-10 17:56:16 +00001001 <https://sqlite.org/c3ref/enable_shared_cache.html>`_ for more details.
Erlend Egeberg Aaslandddb5e112021-01-06 01:36:04 +01001002 If shared cache must be used, open the database in URI mode using the
1003 ``cache=shared`` query parameter.
1004 (Contributed by Erlend E. Aasland in :issue:`24464`.)
1005
Pablo Galindod4fe0982020-05-19 03:33:01 +01001006
Pablo Galindod4fe0982020-05-19 03:33:01 +01001007Removed
1008=======
1009
Serhiy Storchakae2ec0b22020-10-09 14:14:37 +03001010* Removed special methods ``__int__``, ``__float__``, ``__floordiv__``,
1011 ``__mod__``, ``__divmod__``, ``__rfloordiv__``, ``__rmod__`` and
1012 ``__rdivmod__`` of the :class:`complex` class. They always raised
1013 a :exc:`TypeError`.
1014 (Contributed by Serhiy Storchaka in :issue:`41974`.)
1015
Berker Peksagd4d127f2020-07-16 09:38:58 +03001016* The ``ParserBase.error()`` method from the private and undocumented ``_markupbase``
1017 module has been removed. :class:`html.parser.HTMLParser` is the only subclass of
1018 ``ParserBase`` and its ``error()`` implementation has already been removed in
1019 Python 3.5.
1020 (Contributed by Berker Peksag in :issue:`31844`.)
1021
Victor Stinner84f73822020-10-27 04:36:22 +01001022* Removed the ``unicodedata.ucnhash_CAPI`` attribute which was an internal
1023 PyCapsule object. The related private ``_PyUnicode_Name_CAPI`` structure was
1024 moved to the internal C API.
1025 (Contributed by Victor Stinner in :issue:`42157`.)
1026
Lysandros Nikolaouc26d5912020-11-16 20:46:37 +02001027* Removed the ``parser`` module, which was deprecated in 3.9 due to the
1028 switch to the new PEG parser, as well as all the C source and header files
1029 that were only being used by the old parser, including ``node.h``, ``parser.h``,
1030 ``graminit.h`` and ``grammar.h``.
1031
1032* Removed the Public C API functions :c:func:`PyParser_SimpleParseStringFlags`,
1033 :c:func:`PyParser_SimpleParseStringFlagsFilename`,
1034 :c:func:`PyParser_SimpleParseFileFlags` and :c:func:`PyNode_Compile`
1035 that were deprecated in 3.9 due to the switch to the new PEG parser.
1036
Dong-hee Nabe319c02020-11-25 22:17:30 +09001037* Removed the ``formatter`` module, which was deprecated in Python 3.4.
1038 It is somewhat obsolete, little used, and not tested. It was originally
1039 scheduled to be removed in Python 3.6, but such removals were delayed until
1040 after Python 2.7 EOL. Existing users should copy whatever classes they use
1041 into their code.
1042 (Contributed by Dong-hee Na and Terry J. Reedy in :issue:`42299`.)
Pablo Galindod4fe0982020-05-19 03:33:01 +01001043
Hai Shi0f91f582020-12-08 22:42:42 +08001044* Removed the :c:func:`PyModule_GetWarningsModule` function that was useless
1045 now due to the _warnings module was converted to a builtin module in 2.6.
1046 (Contributed by Hai Shi in :issue:`42599`.)
1047
Hugo van Kemenadec47c78b2021-01-13 01:16:37 +02001048* Remove deprecated aliases to :ref:`collections-abstract-base-classes` from
1049 the :mod:`collections` module.
1050 (Contributed by Victor Stinner in :issue:`37324`.)
1051
Ken Jindcea78f2021-01-20 16:16:12 -08001052* The ``loop`` parameter has been removed from most of :mod:`asyncio`\ 's
1053 :doc:`high-level API <../library/asyncio-api-index>` following deprecation
1054 in Python 3.8. The motivation behind this change is multifold:
1055
1056 1. This simplifies the high-level API.
1057 2. The functions in the high-level API have been implicitly getting the
1058 current thread's running event loop since Python 3.7. There isn't a need to
1059 pass the event loop to the API in most normal use cases.
1060 3. Event loop passing is error-prone especially when dealing with loops
1061 running in different threads.
1062
1063 Note that the low-level API will still accept ``loop``.
1064 See `Changes in the Python API`_ for examples of how to replace existing code.
1065
1066 (Contributed by Yurii Karabas, Andrew Svetlov, Yury Selivanov and Kyle Stanley
1067 in :issue:`42392`.)
1068
Hai Shi0f91f582020-12-08 22:42:42 +08001069
Pablo Galindod4fe0982020-05-19 03:33:01 +01001070Porting to Python 3.10
1071======================
1072
1073This section lists previously described changes and other bugfixes
1074that may require changes to your code.
1075
1076
Zackery Spytz91e93792020-11-05 15:18:44 -07001077Changes in the Python API
1078-------------------------
1079
1080* The *etype* parameters of the :func:`~traceback.format_exception`,
1081 :func:`~traceback.format_exception_only`, and
1082 :func:`~traceback.print_exception` functions in the :mod:`traceback` module
1083 have been renamed to *exc*.
1084 (Contributed by Zackery Spytz and Matthias Bussonnier in :issue:`26389`.)
1085
Victor Stinner357704c2020-12-14 23:07:54 +01001086* :mod:`atexit`: At Python exit, if a callback registered with
1087 :func:`atexit.register` fails, its exception is now logged. Previously, only
1088 some exceptions were logged, and the last exception was always silently
1089 ignored.
1090 (Contributed by Victor Stinner in :issue:`42639`.)
1091
kjd75f6f72020-12-19 01:39:26 +08001092* :class:`collections.abc.Callable` generic now flattens type parameters, similar
1093 to what :data:`typing.Callable` currently does. This means that
1094 ``collections.abc.Callable[[int, str], str]`` will have ``__args__`` of
1095 ``(int, str, str)``; previously this was ``([int, str], str)``. Code which
1096 accesses the arguments via :func:`typing.get_args` or ``__args__`` need to account
1097 for this change. Furthermore, :exc:`TypeError` may be raised for invalid forms
1098 of parameterizing :class:`collections.abc.Callable` which may have passed
1099 silently in Python 3.9.
1100 (Contributed by Ken Jin in :issue:`42195`.)
Victor Stinner357704c2020-12-14 23:07:54 +01001101
Erlend Egeberg Aaslandf4936ad2020-12-31 14:16:50 +01001102* :meth:`socket.htons` and :meth:`socket.ntohs` now raise :exc:`OverflowError`
1103 instead of :exc:`DeprecationWarning` if the given parameter will not fit in
1104 a 16-bit unsigned integer.
1105 (Contributed by Erlend E. Aasland in :issue:`42393`.)
1106
Ken Jindcea78f2021-01-20 16:16:12 -08001107* The ``loop`` parameter has been removed from most of :mod:`asyncio`\ 's
1108 :doc:`high-level API <../library/asyncio-api-index>` following deprecation
1109 in Python 3.8.
1110
1111 A coroutine that currently look like this::
1112
1113 async def foo(loop):
1114 await asyncio.sleep(1, loop=loop)
1115
1116 Should be replaced with this::
1117
1118 async def foo():
1119 await asyncio.sleep(1)
1120
1121 If ``foo()`` was specifically designed *not* to run in the current thread's
1122 running event loop (e.g. running in another thread's event loop), consider
1123 using :func:`asyncio.run_coroutine_threadsafe` instead.
1124
1125 (Contributed by Yurii Karabas, Andrew Svetlov, Yury Selivanov and Kyle Stanley
1126 in :issue:`42392`.)
Erlend Egeberg Aaslandf4936ad2020-12-31 14:16:50 +01001127
Victor Stinner46496f92021-02-20 15:17:18 +01001128* The :data:`types.FunctionType` constructor now inherits the current builtins
1129 if the *globals* dictionary has no ``"__builtins__"`` key, rather than using
1130 ``{"None": None}`` as builtins: same behavior as :func:`eval` and
1131 :func:`exec` functions. Defining a function with ``def function(...): ...``
1132 in Python is not affected, globals cannot be overriden with this syntax: it
1133 also inherits the current builtins.
1134 (Contributed by Victor Stinner in :issue:`42990`.)
1135
Yurii Karabas73019792020-11-25 12:43:18 +02001136CPython bytecode changes
1137========================
1138
1139* The ``MAKE_FUNCTION`` instruction accepts tuple of strings as annotations
1140 instead of dictionary.
1141 (Contributed by Yurii Karabas and Inada Naoki in :issue:`42202`)
Dong-hee Naad3252b2020-05-26 01:52:54 +09001142
1143Build Changes
1144=============
1145
Victor Stinner7ab92d52020-06-16 00:54:44 +02001146* The C99 functions :c:func:`snprintf` and :c:func:`vsnprintf` are now required
1147 to build Python.
1148 (Contributed by Victor Stinner in :issue:`36020`.)
1149
Erlend Egeberg Aaslandcf0b2392021-01-06 01:02:43 +01001150* :mod:`sqlite3` requires SQLite 3.7.15 or higher. (Contributed by Sergey Fedoseev
1151 and Erlend E. Aasland :issue:`40744` and :issue:`40810`.)
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +02001152
Victor Stinner357704c2020-12-14 23:07:54 +01001153* The :mod:`atexit` module must now always be built as a built-in module.
1154 (Contributed by Victor Stinner in :issue:`42639`.)
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +02001155
pxinwr277ce302020-12-30 20:50:39 +08001156* Added ``--disable-test-modules`` option to the ``configure`` script:
1157 don't build nor install test modules.
1158 (Contributed by Xavier de Gaye, Thomas Petazzoni and Peixing Xin in :issue:`27640`.)
1159
Victor Stinner75e59a92021-01-20 17:07:21 +01001160* Add ``--with-wheel-pkg-dir=PATH`` option to the ``./configure`` script. If
1161 specified, the :mod:`ensurepip` module looks for ``setuptools`` and ``pip``
1162 wheel packages in this directory: if both are present, these wheel packages
1163 are used instead of ensurepip bundled wheel packages.
1164
1165 Some Linux distribution packaging policies recommend against bundling
1166 dependencies. For example, Fedora installs wheel packages in the
1167 ``/usr/share/python-wheels/`` directory and don't install the
1168 ``ensurepip._bundled`` package.
1169
1170 (Contributed by Victor Stinner in :issue:`42856`.)
1171
Victor Stinner801bb0b2021-02-17 11:14:42 +01001172* Add a new configure ``--without-static-libpython`` option to not build the
1173 ``libpythonMAJOR.MINOR.a`` static library and not install the ``python.o``
1174 object file.
1175
1176 (Contributed by Victor Stinner in :issue:`43103`.)
1177
Ned Deilya65b0502021-03-01 00:27:20 -05001178* The ``configure`` script now uses the ``pkg-config`` utility, if available,
1179 to detect the location of Tcl/Tk headers and libraries. As before, those
1180 locations can be explicitly specified with the ``--with-tcltk-includes``
1181 and ``--with-tcltk-libs`` configuration options.
1182 (Contributed by Manolis Stamatogiannakis in :issue:`42603`.)
1183
Dong-hee Naad3252b2020-05-26 01:52:54 +09001184
1185C API Changes
1186=============
1187
1188New Features
1189------------
1190
Victor Stinnerdd8a93e2020-06-30 00:49:03 +02001191* The result of :c:func:`PyNumber_Index` now always has exact type :class:`int`.
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +03001192 Previously, the result could have been an instance of a subclass of ``int``.
1193 (Contributed by Serhiy Storchaka in :issue:`40792`.)
1194
Victor Stinnerdd8a93e2020-06-30 00:49:03 +02001195* Add a new :c:member:`~PyConfig.orig_argv` member to the :c:type:`PyConfig`
1196 structure: the list of the original command line arguments passed to the
1197 Python executable.
1198 (Contributed by Victor Stinner in :issue:`23427`.)
Dong-hee Naad3252b2020-05-26 01:52:54 +09001199
Zackery Spytz2e4dd332020-09-23 12:43:45 -06001200* The :c:func:`PyDateTime_DATE_GET_TZINFO` and
1201 :c:func:`PyDateTime_TIME_GET_TZINFO` macros have been added for accessing
1202 the ``tzinfo`` attributes of :class:`datetime.datetime` and
1203 :class:`datetime.time` objects.
1204 (Contributed by Zackery Spytz in :issue:`30155`.)
1205
Hai Shid332e7b2020-09-29 05:41:11 +08001206* Add a :c:func:`PyCodec_Unregister` function to unregister a codec
1207 search function.
1208 (Contributed by Hai Shi in :issue:`41842`.)
1209
Vladimir Matveev24a54c02020-10-12 12:10:42 -07001210* The :c:func:`PyIter_Send` function was added to allow
Vladimir Matveev037245c2020-10-09 17:15:15 -07001211 sending value into iterator without raising ``StopIteration`` exception.
1212 (Contributed by Vladimir Matveev in :issue:`41756`.)
1213
Alex Gaynor3a8fdb22020-10-19 18:17:50 -04001214* Added :c:func:`PyUnicode_AsUTF8AndSize` to the limited C API.
1215 (Contributed by Alex Gaynor in :issue:`41784`.)
1216
Victor Stinner80218752020-11-04 13:59:15 +01001217* Added :c:func:`PyModule_AddObjectRef` function: similar to
Victor Stinner95ce7cd2020-11-11 01:52:26 +01001218 :c:func:`PyModule_AddObject` but don't steal a reference to the value on
Victor Stinner80218752020-11-04 13:59:15 +01001219 success.
1220 (Contributed by Victor Stinner in :issue:`1635741`.)
1221
Victor Stinner53a03aa2020-11-05 15:02:12 +01001222* Added :c:func:`Py_NewRef` and :c:func:`Py_XNewRef` functions to increment the
1223 reference count of an object and return the object.
1224 (Contributed by Victor Stinner in :issue:`42262`.)
1225
Serhiy Storchaka686c2032020-11-22 13:25:02 +02001226* The :c:func:`PyType_FromSpecWithBases` and :c:func:`PyType_FromModuleAndSpec`
1227 functions now accept a single class as the *bases* argument.
1228 (Contributed by Serhiy Storchaka in :issue:`42423`.)
1229
Hai Shi88c2cfd2020-11-07 00:04:47 +08001230* The :c:func:`PyType_FromModuleAndSpec` function now accepts NULL ``tp_doc``
1231 slot.
1232 (Contributed by Hai Shi in :issue:`41832`.)
1233
Hai Shia13b26c2020-11-11 04:53:46 +08001234* The :c:func:`PyType_GetSlot` function can accept static types.
1235 (Contributed by Hai Shi and Petr Viktorin in :issue:`41073`.)
1236
Pablo Galindod439fb32021-02-20 18:03:08 +00001237* Add a new :c:func:`PySet_CheckExact` function to the C-API to check if an
1238 object is an instance of :class:`set` but not an instance of a subtype.
1239 (Contributed by Pablo Galindo in :issue:`43277`.)
Alex Gaynor3a8fdb22020-10-19 18:17:50 -04001240
Antoine Pitrouba251c22021-03-11 23:35:45 +01001241* Added :c:func:`PyErr_SetInterruptEx` which allows passing a signal number
1242 to simulate.
1243 (Contributed by Antoine Pitrou in :issue:`43356`.)
1244
1245
Dong-hee Naad3252b2020-05-26 01:52:54 +09001246Porting to Python 3.10
1247----------------------
1248
Victor Stinner37bb2892020-06-19 11:45:31 +02001249* The ``PY_SSIZE_T_CLEAN`` macro must now be defined to use
1250 :c:func:`PyArg_ParseTuple` and :c:func:`Py_BuildValue` formats which use
1251 ``#``: ``es#``, ``et#``, ``s#``, ``u#``, ``y#``, ``z#``, ``U#`` and ``Z#``.
1252 See :ref:`Parsing arguments and building values
1253 <arg-parsing>` and the :pep:`353`.
1254 (Contributed by Victor Stinner in :issue:`40943`.)
1255
Victor Stinnerfe2978b2020-05-27 14:55:10 +02001256* Since :c:func:`Py_REFCNT()` is changed to the inline static function,
1257 ``Py_REFCNT(obj) = new_refcnt`` must be replaced with ``Py_SET_REFCNT(obj, new_refcnt)``:
Victor Stinnerdc24b8a2020-06-04 22:10:43 +02001258 see :c:func:`Py_SET_REFCNT()` (available since Python 3.9). For backward
1259 compatibility, this macro can be used::
1260
1261 #if PY_VERSION_HEX < 0x030900A4
1262 # define Py_SET_REFCNT(obj, refcnt) ((Py_REFCNT(obj) = (refcnt)), (void)0)
1263 #endif
1264
Victor Stinnerfe2978b2020-05-27 14:55:10 +02001265 (Contributed by Victor Stinner in :issue:`39573`.)
1266
Victor Stinner59d3dce2020-06-02 14:03:25 +02001267* Calling :c:func:`PyDict_GetItem` without :term:`GIL` held had been allowed
1268 for historical reason. It is no longer allowed.
1269 (Contributed by Victor Stinner in :issue:`40839`.)
1270
Inada Naoki038dd0f2020-06-30 15:26:56 +09001271* ``PyUnicode_FromUnicode(NULL, size)`` and ``PyUnicode_FromStringAndSize(NULL, size)``
1272 raise ``DeprecationWarning`` now. Use :c:func:`PyUnicode_New` to allocate
1273 Unicode object without initial data.
1274 (Contributed by Inada Naoki in :issue:`36346`.)
1275
Victor Stinner47e1afd2020-10-26 16:43:47 +01001276* The private ``_PyUnicode_Name_CAPI`` structure of the PyCapsule API
Victor Stinner84f73822020-10-27 04:36:22 +01001277 ``unicodedata.ucnhash_CAPI`` has been moved to the internal C API.
Victor Stinner920cb642020-10-26 19:19:36 +01001278 (Contributed by Victor Stinner in :issue:`42157`.)
Victor Stinner47e1afd2020-10-26 16:43:47 +01001279
Victor Stinnerace3f9a2020-11-10 21:10:22 +01001280* :c:func:`Py_GetPath`, :c:func:`Py_GetPrefix`, :c:func:`Py_GetExecPrefix`,
1281 :c:func:`Py_GetProgramFullPath`, :c:func:`Py_GetPythonHome` and
1282 :c:func:`Py_GetProgramName` functions now return ``NULL`` if called before
1283 :c:func:`Py_Initialize` (before Python is initialized). Use the new
1284 :ref:`Python Initialization Configuration API <init-config>` to get the
1285 :ref:`Python Path Configuration. <init-path-config>`.
1286 (Contributed by Victor Stinner in :issue:`42260`.)
1287
Victor Stinner0ef96c22020-12-07 11:56:20 +01001288* :c:func:`PyList_SET_ITEM`, :c:func:`PyTuple_SET_ITEM` and
1289 :c:func:`PyCell_SET` macros can no longer be used as l-value or r-value.
1290 For example, ``x = PyList_SET_ITEM(a, b, c)`` and
1291 ``PyList_SET_ITEM(a, b, c) = x`` now fail with a compiler error. It prevents
1292 bugs like ``if (PyList_SET_ITEM (a, b, c) < 0) ...`` test.
1293 (Contributed by Zackery Spytz and Victor Stinner in :issue:`30459`.)
1294
Nicholas Sim4a6bf272021-02-19 22:55:46 +08001295* The non-limited API files ``odictobject.h``, ``parser_interface.h``,
1296 ``picklebufobject.h``, ``pyarena.h``, ``pyctype.h``, ``pydebug.h``,
1297 ``pyfpe.h``, and ``pytime.h`` have been moved to the ``Include/cpython``
1298 directory. These files must not be included directly, as they are already
1299 included in ``Python.h``: :ref:`Include Files <api-includes>`. If they have
1300 been included directly, consider including ``Python.h`` instead.
1301 (Contributed by Nicholas Sim in :issue:`35134`)
1302
Victor Stinner583ee5a2020-10-02 14:49:00 +02001303Deprecated
1304----------
1305
1306* The ``PyUnicode_InternImmortal()`` function is now deprecated
1307 and will be removed in Python 3.12: use :c:func:`PyUnicode_InternInPlace`
1308 instead.
1309 (Contributed by Victor Stinner in :issue:`41692`.)
1310
Dong-hee Naad3252b2020-05-26 01:52:54 +09001311Removed
1312-------
Inada Naoki6f8a6ee2020-06-26 08:07:22 +09001313
1314* ``PyObject_AsCharBuffer()``, ``PyObject_AsReadBuffer()``, ``PyObject_CheckReadBuffer()``,
1315 and ``PyObject_AsWriteBuffer()`` are removed. Please migrate to new buffer protocol;
1316 :c:func:`PyObject_GetBuffer` and :c:func:`PyBuffer_Release`.
Inada Naoki20a79022020-06-27 18:22:09 +09001317 (Contributed by Inada Naoki in :issue:`41103`.)
1318
1319* Removed ``Py_UNICODE_str*`` functions manipulating ``Py_UNICODE*`` strings.
1320 (Contributed by Inada Naoki in :issue:`41123`.)
1321
1322 * ``Py_UNICODE_strlen``: use :c:func:`PyUnicode_GetLength` or
1323 :c:macro:`PyUnicode_GET_LENGTH`
1324 * ``Py_UNICODE_strcat``: use :c:func:`PyUnicode_CopyCharacters` or
1325 :c:func:`PyUnicode_FromFormat`
1326 * ``Py_UNICODE_strcpy``, ``Py_UNICODE_strncpy``: use
1327 :c:func:`PyUnicode_CopyCharacters` or :c:func:`PyUnicode_Substring`
1328 * ``Py_UNICODE_strcmp``: use :c:func:`PyUnicode_Compare`
1329 * ``Py_UNICODE_strncmp``: use :c:func:`PyUnicode_Tailmatch`
1330 * ``Py_UNICODE_strchr``, ``Py_UNICODE_strrchr``: use
1331 :c:func:`PyUnicode_FindChar`
Inada Naokid9f2a132020-06-29 10:46:51 +09001332
1333* Removed ``PyUnicode_GetMax()``. Please migrate to new (:pep:`393`) APIs.
1334 (Contributed by Inada Naoki in :issue:`41103`.)
Inada Naokie4f1fe62020-06-29 13:00:43 +09001335
1336* Removed ``PyLong_FromUnicode()``. Please migrate to :c:func:`PyLong_FromUnicodeObject`.
1337 (Contributed by Inada Naoki in :issue:`41103`.)
Inada Naokib3332662020-06-30 12:23:07 +09001338
1339* Removed ``PyUnicode_AsUnicodeCopy()``. Please use :c:func:`PyUnicode_AsUCS4Copy` or
1340 :c:func:`PyUnicode_AsWideCharString`
1341 (Contributed by Inada Naoki in :issue:`41103`.)
Victor Stinner19c3ac92020-09-23 14:04:57 +02001342
1343* Removed ``_Py_CheckRecursionLimit`` variable: it has been replaced by
1344 ``ceval.recursion_limit`` of the :c:type:`PyInterpreterState` structure.
1345 (Contributed by Victor Stinner in :issue:`41834`.)
Serhiy Storchakadcc54212020-10-05 12:32:00 +03001346
1347* Removed undocumented macros ``Py_ALLOW_RECURSION`` and
1348 ``Py_END_ALLOW_RECURSION`` and the ``recursion_critical`` field of the
1349 :c:type:`PyInterpreterState` structure.
1350 (Contributed by Serhiy Storchaka in :issue:`41936`.)
Victor Stinner296a7962020-11-17 16:22:23 +01001351
1352* Removed the undocumented ``PyOS_InitInterrupts()`` function. Initializing
1353 Python already implicitly installs signal handlers: see
1354 :c:member:`PyConfig.install_signal_handlers`.
1355 (Contributed by Victor Stinner in :issue:`41713`.)
Victor Stinnereec8e612021-03-18 14:57:49 +01001356
1357* Remove the ``PyAST_Validate()`` function. It is no longer possible to build a
1358 AST object (``mod_ty`` type) with the public C API. The function was already
1359 excluded from the limited C API (:pep:`384`).
1360 (Contributed by Victor Stinner in :issue:`43244`.)