blob: 223ab65cfc311848907eb2bdfc04c16698201479 [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
Christian Heimes39258d32021-04-17 11:36:35 +020068* :pep:`644`, require OpenSSL 1.1.1 or newer
Pablo Galindod4fe0982020-05-19 03:33:01 +010069
70
71New Features
72============
73
Batuhan Taskaya044a1042020-10-06 23:03:02 +030074.. _whatsnew310-pep563:
75
Pablo Galindo7c8e0b02021-01-25 23:15:51 +000076Parenthesized context managers
77------------------------------
78
79Using enclosing parentheses for continuation across multiple lines
80in context managers is now supported. This allows formatting a long
81collection of context managers in multiple lines in a similar way
82as it was previously possible with import statements. For instance,
83all these examples are now valid:
84
85.. code-block:: python
86
87 with (CtxManager() as example):
88 ...
89
90 with (
91 CtxManager1(),
92 CtxManager2()
93 ):
94 ...
95
96 with (CtxManager1() as example,
97 CtxManager2()):
98 ...
99
100 with (CtxManager1(),
101 CtxManager2() as example):
102 ...
103
104 with (
105 CtxManager1() as example1,
106 CtxManager2() as example2
107 ):
108 ...
109
110it is also possible to use a trailing comma at the end of the
111enclosed group:
112
113.. code-block:: python
114
115 with (
116 CtxManager1() as example1,
117 CtxManager2() as example2,
118 CtxManager3() as example3,
119 ):
120 ...
121
122This new syntax uses the non LL(1) capacities of the new parser.
123Check :pep:`617` for more details.
124
125(Contributed by Guido van Rossum, Pablo Galindo and Lysandros Nikolaou
126in :issue:`12782` and :issue:`40334`.)
127
128
Pablo Galindo37494b42021-04-14 02:36:07 +0100129Better error messages
130---------------------
131
132SyntaxErrors
133~~~~~~~~~~~~
Batuhan Taskaya044a1042020-10-06 23:03:02 +0300134
Ken Jin727a68b2021-03-03 08:52:03 +0800135When parsing code that contains unclosed parentheses or brackets the interpreter
136now includes the location of the unclosed bracket of parentheses instead of displaying
137*SyntaxError: unexpected EOF while parsing* or pointing to some incorrect location.
138For instance, consider the following code (notice the unclosed '{'):
Batuhan Taskaya044a1042020-10-06 23:03:02 +0300139
Ken Jin727a68b2021-03-03 08:52:03 +0800140.. code-block:: python
Pablo Galindod4fe0982020-05-19 03:33:01 +0100141
Ken Jin727a68b2021-03-03 08:52:03 +0800142 expected = {9: 1, 18: 2, 19: 2, 27: 3, 28: 3, 29: 3, 36: 4, 37: 4,
143 38: 4, 39: 4, 45: 5, 46: 5, 47: 5, 48: 5, 49: 5, 54: 6,
144 some_other_code = foo()
Dennis Sweeney3ee0e482020-06-12 13:19:25 -0400145
Ken Jin727a68b2021-03-03 08:52:03 +0800146previous versions of the interpreter reported confusing places as the location of
147the syntax error:
Ram Rachum59cf8532020-06-19 23:39:22 +0300148
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100149.. code-block:: python
Mikhail Golubev4f3c2502020-10-08 00:44:31 +0300150
Ken Jin727a68b2021-03-03 08:52:03 +0800151 File "example.py", line 3
152 some_other_code = foo()
153 ^
154 SyntaxError: invalid syntax
Mikhail Golubev4f3c2502020-10-08 00:44:31 +0300155
Ken Jin727a68b2021-03-03 08:52:03 +0800156but in Python3.10 a more informative error is emitted:
Mikhail Golubev4f3c2502020-10-08 00:44:31 +0300157
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100158.. code-block:: python
Mikhail Golubev4f3c2502020-10-08 00:44:31 +0300159
Ken Jin727a68b2021-03-03 08:52:03 +0800160 File "example.py", line 1
161 expected = {9: 1, 18: 2, 19: 2, 27: 3, 28: 3, 29: 3, 36: 4, 37: 4,
162 ^
163 SyntaxError: '{' was never closed
Fidget-Spinner8e1dd552020-10-05 12:40:52 +0800164
165
Ken Jin727a68b2021-03-03 08:52:03 +0800166In a similar way, errors involving unclosed string literals (single and triple
167quoted) now point to the start of the string instead of reporting EOF/EOL.
Fidget-Spinner8e1dd552020-10-05 12:40:52 +0800168
Ken Jin727a68b2021-03-03 08:52:03 +0800169These improvements are inspired by previous work in the PyPy interpreter.
Fidget-Spinner8e1dd552020-10-05 12:40:52 +0800170
Ken Jin727a68b2021-03-03 08:52:03 +0800171(Contributed by Pablo Galindo in :issue:`42864` and Batuhan Taskaya in
172:issue:`40176`.)
Fidget-Spinner8e1dd552020-10-05 12:40:52 +0800173
Pablo Galindoa77aac42021-04-23 14:27:05 +0100174:exc:`SyntaxError` exceptions raised by the intepreter will now highlight the
175full error range of the expression that consistutes the syntax error itself,
176instead of just where the problem is detected. In this way, instead of displaying
177(before Python 3.10):
178
179.. code-block:: python
180
181 >>> foo(x, z for z in range(10), t, w)
182 File "<stdin>", line 1
183 foo(x, z for z in range(10), t, w)
184 ^
185 SyntaxError: Generator expression must be parenthesized
186
187now Python 3.10 will display the exception as:
188
189.. code-block:: python
190
191 >>> foo(x, z for z in range(10), t, w)
192 File "<stdin>", line 1
193 foo(x, z for z in range(10), t, w)
194 ^^^^^^^^^^^^^^^^^^^^
195 SyntaxError: Generator expression must be parenthesized
196
197This improvement has been contributed by Pablo Galindo in :issue:`43914`.
198
JunWei Song18e0d322021-04-22 01:34:05 +0800199A considerable amount of new specialized messages for :exc:`SyntaxError` exceptions
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100200have been incorporated. Some of the most notable ones:
201
202* Missing ``:`` before blocks:
203
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100204 .. code-block:: python
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100205
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100206 >>> if rocket.position > event_horizon
207 File "<stdin>", line 1
208 if rocket.position > event_horizon
209 ^
210 SyntaxError: expected ':'
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100211
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100212 (Contributed by Pablo Galindo in :issue:`42997`)
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100213
214* Unparenthesised tuples in comprehensions targets:
215
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100216 .. code-block:: python
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100217
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100218 >>> {x,y for x,y in range(100)}
219 File "<stdin>", line 1
220 {x,y for x,y in range(100)}
221 ^
222 SyntaxError: did you forget parentheses around the comprehension target?
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100223
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100224 (Contributed by Pablo Galindo in :issue:`43017`)
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100225
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100226* Missing commas in collection literals and between expressions:
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100227
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100228 .. code-block:: python
229
230 >>> items = {
231 ... x: 1,
232 ... y: 2
233 ... z: 3,
234 File "<stdin>", line 3
235 y: 2
236 ^
237 SyntaxError: invalid syntax. Perhaps you forgot a comma?
238
239 (Contributed by Pablo Galindo in :issue:`43822`)
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100240
241* Exception groups without parentheses:
242
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100243 .. code-block:: python
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100244
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100245 >>> try:
246 ... build_dyson_sphere()
247 ... except NotEnoughScienceError, NotEnoughResourcesError:
248 File "<stdin>", line 3
249 except NotEnoughScienceError, NotEnoughResourcesError:
250 ^
251 SyntaxError: exception group must be parenthesized
252
253 (Contributed by Pablo Galindo in :issue:`43149`)
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100254
255* Missing ``:`` and values in dictionary literals:
256
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100257 .. code-block:: python
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100258
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100259 >>> values = {
260 ... x: 1,
261 ... y: 2,
262 ... z:
263 ... }
264 File "<stdin>", line 4
265 z:
266 ^
267 SyntaxError: expression expected after dictionary key and ':'
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100268
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100269 >>> values = {x:1, y:2, z w:3}
270 File "<stdin>", line 1
271 values = {x:1, y:2, z w:3}
272 ^
273 SyntaxError: ':' expected after dictionary key
274
275 (Contributed by Pablo Galindo in :issue:`43823`)
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100276
277* Usage of ``=`` instead of ``==`` in comparisons:
278
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100279 .. code-block:: python
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100280
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100281 >>> if rocket.position = event_horizon:
282 File "<stdin>", line 1
283 if rocket.position = event_horizon:
284 ^
285 SyntaxError: cannot assign to attribute here. Maybe you meant '==' instead of '='?
286
287 (Contributed by Pablo Galindo in :issue:`43797`)
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100288
289* Usage of ``*`` in f-strings:
290
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100291 .. code-block:: python
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100292
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100293 >>> f"Black holes {*all_black_holes} and revelations"
294 File "<stdin>", line 1
295 (*all_black_holes)
296 ^
297 SyntaxError: f-string: cannot use starred expression here
Pablo Galindoff3d9c02021-04-16 01:28:48 +0100298
Pablo Galindo8bf274a2021-04-17 22:41:46 +0100299 (Contributed by Pablo Galindo in :issue:`41064`)
Pablo Galindo37494b42021-04-14 02:36:07 +0100300
Pablo Galindo56c95df2021-04-21 15:28:21 +0100301IndentationErrors
302~~~~~~~~~~~~~~~~~
303
304Many :exc:`IndentationError` exceptions now have more context regarding what kind of block
305was expecting an indentation, including the location of the statement:
306
307.. code-block:: python
308
309 >>> def foo():
310 ... if lel:
311 ... x = 2
312 File "<stdin>", line 3
313 x = 2
314 ^
315 IndentationError: expected an indented block after 'if' statement in line 2
316
317
Pablo Galindo37494b42021-04-14 02:36:07 +0100318AttributeErrors
319~~~~~~~~~~~~~~~
320
321When printing :exc:`AttributeError`, :c:func:`PyErr_Display` will offer
Pablo Galindoc4073a22021-04-14 14:16:47 +0100322suggestions of similar attribute names in the object that the exception was
Pablo Galindo37494b42021-04-14 02:36:07 +0100323raised from:
324
325.. code-block:: python
326
327 >>> collections.namedtoplo
328 Traceback (most recent call last):
329 File "<stdin>", line 1, in <module>
330 AttributeError: module 'collections' has no attribute 'namedtoplo'. Did you mean: namedtuple?
331
332(Contributed by Pablo Galindo in :issue:`38530`.)
333
Pablo Galindo5bf8bf22021-04-14 15:10:33 +0100334NameErrors
335~~~~~~~~~~
336
337When printing :exc:`NameError` raised by the interpreter, :c:func:`PyErr_Display`
JunWei Song18e0d322021-04-22 01:34:05 +0800338will offer suggestions of similar variable names in the function that the exception
Pablo Galindo5bf8bf22021-04-14 15:10:33 +0100339was raised from:
340
341.. code-block:: python
342
343 >>> schwarzschild_black_hole = None
344 >>> schwarschild_black_hole
345 Traceback (most recent call last):
346 File "<stdin>", line 1, in <module>
347 NameError: name 'schwarschild_black_hole' is not defined. Did you mean: schwarzschild_black_hole?
348
349(Contributed by Pablo Galindo in :issue:`38530`.)
350
Mark Shannon6086ae72021-03-16 13:43:58 +0000351PEP 626: Precise line numbers for debugging and other tools
352-----------------------------------------------------------
353
354PEP 626 brings more precise and reliable line numbers for debugging, profiling and coverage tools.
355Tracing events, with the correct line number, are generated for all lines of code executed and only for lines of code that are executed.
356
Antti Haapalac3a478b2021-04-11 03:20:41 +0300357The ``f_lineno`` attribute of frame objects will always contain the expected line number.
Mark Shannon6086ae72021-03-16 13:43:58 +0000358
Mark Shannon148bc052021-03-19 17:30:24 +0000359The ``co_lnotab`` attribute of code objects is deprecated and will be removed in 3.12.
360Code that needs to convert from offset to line number should use the new ``co_lines()`` method instead.
Ken Jin11276cd2021-01-02 08:45:50 +0800361
Carol Willing41934b32021-02-28 15:43:17 -0800362PEP 634: Structural Pattern Matching
363------------------------------------
364
365Structural pattern matching has been added in the form of a *match statement*
366and *case statements* of patterns with associated actions. Patterns
367consist of sequences, mappings, primitive data types as well as class instances.
368Pattern matching enables programs to extract information from complex data types,
369branch on the structure of data, and apply specific actions based on different
370forms of data.
371
372Syntax and operations
373~~~~~~~~~~~~~~~~~~~~~
374
375The generic syntax of pattern matching is::
376
377 match subject:
378 case <pattern_1>:
379 <action_1>
380 case <pattern_2>:
381 <action_2>
382 case <pattern_3>:
383 <action_3>
384 case _:
385 <action_wildcard>
386
387A match statement takes an expression and compares its value to successive
388patterns given as one or more case blocks. Specifically, pattern matching
389operates by:
390
391 1. using data with type and shape (the ``subject``)
392 2. evaluating the ``subject`` in the ``match`` statement
393 3. comparing the subject with each pattern in a ``case`` statement
394 from top to bottom until a match is confirmed.
395 4. executing the action associated with the pattern of the confirmed
396 match
397 5. If an exact match is not confirmed, the last case, a wildcard ``_``,
398 if provided, will be used as the matching case. If an exact match is
blopblopy56816bb2021-03-25 18:14:22 +0200399 not confirmed and a wildcard case does not exist, the entire match
Carol Willing41934b32021-02-28 15:43:17 -0800400 block is a no-op.
401
402Declarative approach
403~~~~~~~~~~~~~~~~~~~~
404
405Readers may be aware of pattern matching through the simple example of matching
406a subject (data object) to a literal (pattern) with the switch statement found
407in C, Java or JavaScript (and many other languages). Often the switch statement
408is used for comparison of an object/expression with case statements containing
409literals.
410
411More powerful examples of pattern matching can be found in languages, such as
412Scala and Elixir. With structural pattern matching, the approach is "declarative" and
413explicitly states the conditions (the patterns) for data to match.
414
415While an "imperative" series of instructions using nested "if" statements
416could be used to accomplish something similar to structural pattern matching,
417it is less clear than the "declarative" approach. Instead the "declarative"
418approach states the conditions to meet for a match and is more readable through
419its explicit patterns. While structural pattern matching can be used in its
420simplest form comparing a variable to a literal in a case statement, its
421true value for Python lies in its handling of the subject's type and shape.
422
423Simple pattern: match to a literal
424~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
425
426Let's look at this example as pattern matching in its simplest form: a value,
427the subject, being matched to several literals, the patterns. In the example
428below, ``status`` is the subject of the match statement. The patterns are
429each of the case statements, where literals represent request status codes.
430The associated action to the case is executed after a match::
431
432 def http_error(status):
433 match status:
434 case 400:
435 return "Bad request"
436 case 404:
437 return "Not found"
438 case 418:
439 return "I'm a teapot"
440 case _:
441 return "Something's wrong with the Internet"
442
443If the above function is passed a ``status`` of 418, "I'm a teapot" is returned.
444If the above function is passed a ``status`` of 500, the case statement with
445``_`` will match as a wildcard, and "Something's wrong with the Internet" is
446returned.
447Note the last block: the variable name, ``_``, acts as a *wildcard* and insures
448the subject will always match. The use of ``_`` is optional.
449
450You can combine several literals in a single pattern using ``|`` ("or")::
451
452 case 401 | 403 | 404:
453 return "Not allowed"
454
455Behavior without the wildcard
456^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
457
458If we modify the above example by removing the last case block, the example
459becomes::
460
461 def http_error(status):
462 match status:
463 case 400:
464 return "Bad request"
465 case 404:
466 return "Not found"
467 case 418:
468 return "I'm a teapot"
469
470Without the use of ``_`` in a case statement, a match may not exist. If no
471match exists, the behavior is a no-op. For example, if ``status`` of 500 is
472passed, a no-op occurs.
473
Julien Palardb04f1cb2021-03-03 11:32:12 +0100474Patterns with a literal and variable
475~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Carol Willing41934b32021-02-28 15:43:17 -0800476
477Patterns can look like unpacking assignments, and a pattern may be used to bind
478variables. In this example, a data point can be unpacked to its x-coordinate
479and y-coordinate::
480
481 # point is an (x, y) tuple
482 match point:
483 case (0, 0):
484 print("Origin")
485 case (0, y):
486 print(f"Y={y}")
487 case (x, 0):
488 print(f"X={x}")
489 case (x, y):
490 print(f"X={x}, Y={y}")
491 case _:
492 raise ValueError("Not a point")
493
494The first pattern has two literals, ``(0, 0)``, and may be thought of as an
495extension of the literal pattern shown above. The next two patterns combine a
496literal and a variable, and the variable *binds* a value from the subject
497(``point``). The fourth pattern captures two values, which makes it
498conceptually similar to the unpacking assignment ``(x, y) = point``.
499
500Patterns and classes
501~~~~~~~~~~~~~~~~~~~~
502
503If you are using classes to structure your data, you can use as a pattern
504the class name followed by an argument list resembling a constructor. This
505pattern has the ability to capture class attributes into variables::
506
507 class Point:
508 x: int
509 y: int
510
511 def location(point):
512 match point:
513 case Point(x=0, y=0):
514 print("Origin is the point's location.")
515 case Point(x=0, y=y):
516 print(f"Y={y} and the point is on the y-axis.")
517 case Point(x=x, y=0):
518 print(f"X={x} and the point is on the x-axis.")
519 case Point():
520 print("The point is located somewhere else on the plane.")
521 case _:
522 print("Not a point")
523
524Patterns with positional parameters
525^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
526
527You can use positional parameters with some builtin classes that provide an
528ordering for their attributes (e.g. dataclasses). You can also define a specific
529position for attributes in patterns by setting the ``__match_args__`` special
530attribute in your classes. If it's set to ("x", "y"), the following patterns
531are all equivalent (and all bind the ``y`` attribute to the ``var`` variable)::
532
533 Point(1, var)
534 Point(1, y=var)
535 Point(x=1, y=var)
536 Point(y=var, x=1)
537
538Nested patterns
539~~~~~~~~~~~~~~~
540
541Patterns can be arbitrarily nested. For example, if our data is a short
542list of points, it could be matched like this::
543
544 match points:
545 case []:
546 print("No points in the list.")
547 case [Point(0, 0)]:
548 print("The origin is the only point in the list.")
549 case [Point(x, y)]:
550 print(f"A single point {x}, {y} is in the list.")
551 case [Point(0, y1), Point(0, y2)]:
552 print(f"Two points on the Y axis at {y1}, {y2} are in the list.")
553 case _:
554 print("Something else is found in the list.")
555
556Complex patterns and the wildcard
557~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
558
559To this point, the examples have used ``_`` alone in the last case statement.
560A wildcard can be used in more complex patterns, such as ``('error', code, _)``.
561For example::
562
563 match test_variable:
564 case ('warning', code, 40):
565 print("A warning has been received.")
566 case ('error', code, _):
Zackery Spytz0c4c4362021-04-14 10:16:11 -0600567 print(f"An error {code} occurred.")
Carol Willing41934b32021-02-28 15:43:17 -0800568
569In the above case, ``test_variable`` will match for ('error', code, 100) and
570('error', code, 800).
571
572Guard
573~~~~~
574
575We can add an ``if`` clause to a pattern, known as a "guard". If the
576guard is false, ``match`` goes on to try the next case block. Note
577that value capture happens before the guard is evaluated::
578
579 match point:
580 case Point(x, y) if x == y:
581 print(f"The point is located on the diagonal Y=X at {x}.")
582 case Point(x, y):
583 print(f"Point is not on the diagonal.")
584
585Other Key Features
586~~~~~~~~~~~~~~~~~~
587
588Several other key features:
589
590- Like unpacking assignments, tuple and list patterns have exactly the
591 same meaning and actually match arbitrary sequences. Technically,
592 the subject must be an instance of ``collections.abc.Sequence``.
593 Therefore, an important exception is that patterns don't match iterators.
594 Also, to prevent a common mistake, sequence patterns don't match strings.
595
596- Sequence patterns support wildcards: ``[x, y, *rest]`` and ``(x, y,
597 *rest)`` work similar to wildcards in unpacking assignments. The
598 name after ``*`` may also be ``_``, so ``(x, y, *_)`` matches a sequence
599 of at least two items without binding the remaining items.
600
601- Mapping patterns: ``{"bandwidth": b, "latency": l}`` captures the
602 ``"bandwidth"`` and ``"latency"`` values from a dict. Unlike sequence
603 patterns, extra keys are ignored. A wildcard ``**rest`` is also
Don Kirkby18701a02021-03-31 23:00:30 -0700604 supported. (But ``**_`` would be redundant, so is not allowed.)
Carol Willing41934b32021-02-28 15:43:17 -0800605
606- Subpatterns may be captured using the ``as`` keyword::
607
608 case (Point(x1, y1), Point(x2, y2) as p2): ...
609
610 This binds x1, y1, x2, y2 like you would expect without the ``as`` clause,
611 and p2 to the entire second item of the subject.
612
613- Most literals are compared by equality. However, the singletons ``True``,
614 ``False`` and ``None`` are compared by identity.
615
616- Named constants may be used in patterns. These named constants must be
617 dotted names to prevent the constant from being interpreted as a capture
618 variable::
619
620 from enum import Enum
621 class Color(Enum):
622 RED = 0
623 GREEN = 1
624 BLUE = 2
625
626 match color:
627 case Color.RED:
628 print("I see red!")
629 case Color.GREEN:
630 print("Grass is green")
631 case Color.BLUE:
632 print("I'm feeling the blues :(")
633
634For the full specification see :pep:`634`. Motivation and rationale
635are in :pep:`635`, and a longer tutorial is in :pep:`636`.
636
Pablo Galindo805ede82021-01-21 17:36:35 +0000637
Inada Naoki48274832021-03-29 12:28:14 +0900638.. _whatsnew310-pep597:
639
640Optional ``EncodingWarning`` and ``encoding="locale"`` option
641-------------------------------------------------------------
642
643The default encoding of :class:`TextIOWrapper` and :func:`open` is
644platform and locale dependent. Since UTF-8 is used on most Unix
645platforms, omitting ``encoding`` option when opening UTF-8 files
Don Kirkby18701a02021-03-31 23:00:30 -0700646(e.g. JSON, YAML, TOML, Markdown) is a very common bug. For example::
Inada Naoki48274832021-03-29 12:28:14 +0900647
648 # BUG: "rb" mode or encoding="utf-8" should be used.
649 with open("data.json") as f:
Don Kirkby18701a02021-03-31 23:00:30 -0700650 data = json.load(f)
Inada Naoki48274832021-03-29 12:28:14 +0900651
Don Kirkby18701a02021-03-31 23:00:30 -0700652To find this type of bug, optional ``EncodingWarning`` is added.
Inada Naoki48274832021-03-29 12:28:14 +0900653It is emitted when :data:`sys.flags.warn_default_encoding <sys.flags>`
654is true and locale-specific default encoding is used.
655
656``-X warn_default_encoding`` option and :envvar:`PYTHONWARNDEFAULTENCODING`
657are added to enable the warning.
658
659See :ref:`io-text-encoding` for more information.
660
661
larryhastings99f71ae2021-04-30 22:55:21 -0700662New Features Related to Type Hints
663==================================
Pablo Galindo805ede82021-01-21 17:36:35 +0000664
larryhastings99f71ae2021-04-30 22:55:21 -0700665This section covers major changes affecting :pep:`484` type hints and
Ken Jin727a68b2021-03-03 08:52:03 +0800666the :mod:`typing` module.
Pablo Galindo805ede82021-01-21 17:36:35 +0000667
668
Ken Jin727a68b2021-03-03 08:52:03 +0800669PEP 604: New Type Union Operator
670--------------------------------
671
672A new type union operator was introduced which enables the syntax ``X | Y``.
673This provides a cleaner way of expressing 'either type X or type Y' instead of
larryhastings99f71ae2021-04-30 22:55:21 -0700674using :data:`typing.Union`, especially in type hints.
Ken Jin727a68b2021-03-03 08:52:03 +0800675
676In previous versions of Python, to apply a type hint for functions accepting
677arguments of multiple types, :data:`typing.Union` was used::
678
679 def square(number: Union[int, float]) -> Union[int, float]:
680 return number ** 2
681
682
683Type hints can now be written in a more succinct manner::
684
685 def square(number: int | float) -> int | float:
686 return number ** 2
687
688
689This new syntax is also accepted as the second argument to :func:`isinstance`
690and :func:`issubclass`::
691
692 >>> isinstance(1, int | str)
693 True
694
695See :ref:`types-union` and :pep:`604` for more details.
696
697(Contributed by Maggie Moss and Philippe Prados in :issue:`41428`.)
698
699
700PEP 612: Parameter Specification Variables
701------------------------------------------
702
703Two new options to improve the information provided to static type checkers for
704:pep:`484`\ 's ``Callable`` have been added to the :mod:`typing` module.
705
706The first is the parameter specification variable. They are used to forward the
707parameter types of one callable to another callable -- a pattern commonly
708found in higher order functions and decorators. Examples of usage can be found
709in :class:`typing.ParamSpec`. Previously, there was no easy way to type annotate
710dependency of parameter types in such a precise manner.
711
712The second option is the new ``Concatenate`` operator. It's used in conjunction
713with parameter specification variables to type annotate a higher order callable
714which adds or removes parameters of another callable. Examples of usage can
715be found in :class:`typing.Concatenate`.
716
717See :class:`typing.Callable`, :class:`typing.ParamSpec`,
Jelle Zijlstra52243362021-04-10 19:57:05 -0700718:class:`typing.Concatenate`, :class:`typing.ParamSpecArgs`,
719:class:`typing.ParamSpecKwargs`, and :pep:`612` for more details.
Ken Jin727a68b2021-03-03 08:52:03 +0800720
Jelle Zijlstra52243362021-04-10 19:57:05 -0700721(Contributed by Ken Jin in :issue:`41559`, with minor enhancements by Jelle
722Zijlstra in :issue:`43783`. PEP written by Mark Mendoza.)
Ken Jin727a68b2021-03-03 08:52:03 +0800723
724
larryhastings99f71ae2021-04-30 22:55:21 -0700725PEP 613: TypeAlias
726------------------
Ken Jin727a68b2021-03-03 08:52:03 +0800727
728:pep:`484` introduced the concept of type aliases, only requiring them to be
729top-level unannotated assignments. This simplicity sometimes made it difficult
730for type checkers to distinguish between type aliases and ordinary assignments,
731especially when forward references or invalid types were involved. Compare::
732
733 StrCache = 'Cache[str]' # a type alias
734 LOG_PREFIX = 'LOG[DEBUG]' # a module constant
735
larryhastings99f71ae2021-04-30 22:55:21 -0700736Now the :mod:`typing` module has a special value :data:`TypeAlias`
737which lets you declare type aliases more explicitly::
Ken Jin727a68b2021-03-03 08:52:03 +0800738
739 StrCache: TypeAlias = 'Cache[str]' # a type alias
740 LOG_PREFIX = 'LOG[DEBUG]' # a module constant
741
742See :pep:`613` for more details.
743
744(Contributed by Mikhail Golubev in :issue:`41923`.)
745
Ken Jin05ab4b62021-04-27 22:31:04 +0800746PEP 647: User-Defined Type Guards
747---------------------------------
748
749:data:`TypeGuard` has been added to the :mod:`typing` module to annotate
750type guard functions and improve information provided to static type checkers
751during type narrowing. For more information, please see :data:`TypeGuard`\ 's
752documentation, and :pep:`647`.
753
754(Contributed by Ken Jin and Guido van Rossum in :issue:`43766`.
755PEP written by Eric Traut.)
Pablo Galindo805ede82021-01-21 17:36:35 +0000756
Pablo Galindod4fe0982020-05-19 03:33:01 +0100757Other Language Changes
758======================
759
Ken Jin727a68b2021-03-03 08:52:03 +0800760* The :class:`int` type has a new method :meth:`int.bit_count`, returning the
761 number of ones in the binary expansion of a given integer, also known
762 as the population count. (Contributed by Niklas Fiekas in :issue:`29882`.)
763
764* The views returned by :meth:`dict.keys`, :meth:`dict.values` and
765 :meth:`dict.items` now all have a ``mapping`` attribute that gives a
766 :class:`types.MappingProxyType` object wrapping the original
767 dictionary. (Contributed by Dennis Sweeney in :issue:`40890`.)
768
769* :pep:`618`: The :func:`zip` function now has an optional ``strict`` flag, used
770 to require that all the iterables have an equal length.
771
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300772* Builtin and extension functions that take integer arguments no longer accept
773 :class:`~decimal.Decimal`\ s, :class:`~fractions.Fraction`\ s and other
774 objects that can be converted to integers only with a loss (e.g. that have
775 the :meth:`~object.__int__` method but do not have the
776 :meth:`~object.__index__` method).
777 (Contributed by Serhiy Storchaka in :issue:`37999`.)
Ken Jin727a68b2021-03-03 08:52:03 +0800778
Alexcc02b4f2021-02-26 21:58:39 +0200779* If :func:`object.__ipow__` returns :const:`NotImplemented`, the operator will
780 correctly fall back to :func:`object.__pow__` and :func:`object.__rpow__` as expected.
781 (Contributed by Alex Shkop in :issue:`38302`.)
Pablo Galindod4fe0982020-05-19 03:33:01 +0100782
Lysandros Nikolaoua85fefe2020-11-19 01:49:28 +0200783* Assignment expressions can now be used unparenthesized within set literals
784 and set comprehensions, as well as in sequence indexes (but not slices).
785
Victor Stinnera3c3ffa2021-02-18 12:35:37 +0100786* Functions have a new ``__builtins__`` attribute which is used to look for
787 builtin symbols when a function is executed, instead of looking into
Victor Stinner46496f92021-02-20 15:17:18 +0100788 ``__globals__['__builtins__']``. The attribute is initialized from
789 ``__globals__["__builtins__"]`` if it exists, else from the current builtins.
Victor Stinnera3c3ffa2021-02-18 12:35:37 +0100790 (Contributed by Mark Shannon in :issue:`42990`.)
791
Joshua Bronsonf0a6fde2021-03-23 18:47:21 -0400792* Two new builtin functions -- :func:`aiter` and :func:`anext` have been added
793 to provide asynchronous counterparts to :func:`iter` and :func:`next`,
794 respectively.
795 (Contributed by Joshua Bronson, Daniel Pope, and Justin Wang in :issue:`31861`.)
796
Victor Stinner507a5742021-04-09 17:51:22 +0200797* Static methods (:func:`@staticmethod <staticmethod>`) and class methods
798 (:func:`@classmethod <classmethod>`) now inherit the method attributes
799 (``__module__``, ``__name__``, ``__qualname__``, ``__doc__``,
800 ``__annotations__``) and have a new ``__wrapped__`` attribute.
Victor Stinner553ee272021-04-12 00:21:22 +0200801 Moreover, static methods are now callable as regular functions.
Victor Stinner507a5742021-04-09 17:51:22 +0200802 (Contributed by Victor Stinner in :issue:`43682`.)
803
Batuhan Taskaya8cc3cfa2021-04-25 05:31:20 +0300804* Annotations for complex targets (everything beside ``simple name`` targets
805 defined by :pep:`526`) no longer cause any runtime effects with ``from __future__ import annotations``.
806 (Contributed by Batuhan Taskaya in :issue:`42737`.)
807
larryhastings99f71ae2021-04-30 22:55:21 -0700808* Class and module objects now lazy-create empty annotations dicts on demand.
809 The annotations dicts are stored in the object’s ``__dict__`` for
larryhastings49b26fa2021-05-01 21:19:24 -0700810 backwards compatibility. This improves the best practices for working
811 with ``__annotations__``; for more information, please see
812 :ref:`annotations-howto`.
larryhastings99f71ae2021-04-30 22:55:21 -0700813 (Contributed by Larry Hastings in :issue:`43901`.)
Pablo Galindod4fe0982020-05-19 03:33:01 +0100814
815New Modules
816===========
817
818* None yet.
819
820
821Improved Modules
822================
823
Batuhan Taskaya81fe0142021-04-21 23:44:27 +0300824asyncio
825-------
826
827Added missing :meth:`~asyncio.events.AbstractEventLoop.connect_accepted_socket`
828method.
829(Contributed by Alex Grönholm in :issue:`41332`.)
830
Tomáš Hrnčiarfb35fa42021-01-12 01:41:35 +0100831argparse
832--------
833
834Misleading phrase "optional arguments" was replaced with "options" in argparse help. Some tests might require adaptation if they rely on exact output match.
835(Contributed by Raymond Hettinger in :issue:`9694`.)
836
Zackery Spytzafd12652021-04-02 09:28:35 -0600837array
838-----
839
840The :meth:`~array.array.index` method of :class:`array.array` now has
841optional *start* and *stop* parameters.
842(Contributed by Anders Lorentsen and Zackery Spytz in :issue:`31956`.)
843
Filipe Laíns4ce6faa2020-08-10 15:48:20 +0100844base64
845------
846
847Add :func:`base64.b32hexencode` and :func:`base64.b32hexdecode` to support the
848Base32 Encoding with Extended Hex Alphabet.
849
Batuhan Taskaya81fe0142021-04-21 23:44:27 +0300850bdb
851---
852
853Add :meth:`~bdb.Breakpoint.clearBreakpoints` to reset all set breakpoints.
854(Contributed by Irit Katriel in :issue:`24160`.)
855
Hai Shid332e7b2020-09-29 05:41:11 +0800856codecs
857------
858
859Add a :func:`codecs.unregister` function to unregister a codec search function.
860(Contributed by Hai Shi in :issue:`41842`.)
861
kjd75f6f72020-12-19 01:39:26 +0800862collections.abc
863---------------
864
865The ``__args__`` of the :ref:`parameterized generic <types-genericalias>` for
866:class:`collections.abc.Callable` are now consistent with :data:`typing.Callable`.
867:class:`collections.abc.Callable` generic now flattens type parameters, similar
868to what :data:`typing.Callable` currently does. This means that
869``collections.abc.Callable[[int, str], str]`` will have ``__args__`` of
870``(int, str, str)``; previously this was ``([int, str], str)``. To allow this
871change, :class:`types.GenericAlias` can now be subclassed, and a subclass will
872be returned when subscripting the :class:`collections.abc.Callable` type. Note
873that a :exc:`TypeError` may be raised for invalid forms of parameterizing
874:class:`collections.abc.Callable` which may have passed silently in Python 3.9.
875(Contributed by Ken Jin in :issue:`42195`.)
876
Joongi Kim3eb28462020-11-11 00:19:11 +0900877contextlib
878----------
879
880Add a :func:`contextlib.aclosing` context manager to safely close async generators
881and objects representing asynchronously released resources.
882(Contributed by Joongi Kim and John Belmonte in :issue:`41229`.)
883
Tom Gringauz9c98e8c2020-11-18 00:58:35 +0200884Add asynchronous context manager support to :func:`contextlib.nullcontext`.
885(Contributed by Tom Gringauz in :issue:`41543`.)
886
Batuhan Taskaya81fe0142021-04-21 23:44:27 +0300887Add :class:`AsyncContextDecorator`, for supporting usage of async context managers
888as decorators.
889
Hans Petter Janssonda4e09f2020-08-03 22:51:33 -0500890curses
891------
892
893The extended color functions added in ncurses 6.1 will be used transparently
894by :func:`curses.color_content`, :func:`curses.init_color`,
895:func:`curses.init_pair`, and :func:`curses.pair_content`. A new function,
896:func:`curses.has_extended_color_support`, indicates whether extended color
897support is provided by the underlying ncurses library.
898(Contributed by Jeffrey Kintscher and Hans Petter Jansson in :issue:`36982`.)
899
Zackery Spytz14cfa322021-01-14 02:40:09 -0700900The ``BUTTON5_*`` constants are now exposed in the :mod:`curses` module if
901they are provided by the underlying curses library.
902(Contributed by Zackery Spytz in :issue:`39273`.)
903
Yurii Karabasc2419912021-05-01 05:14:30 +0300904dataclasses
905-----------
906
907Added ``slots`` parameter in :func:`dataclasses.dataclass` decorator.
908(Contributed by Yurii Karabas in :issue:`42269`)
909
Steve Dower62949f62021-01-29 21:48:55 +0000910.. _distutils-deprecated:
911
Victor Stinner0e2a0f72021-01-09 00:35:01 +0100912distutils
913---------
914
Steve Dower62949f62021-01-29 21:48:55 +0000915The entire ``distutils`` package is deprecated, to be removed in Python
9163.12. Its functionality for specifying package builds has already been
917completely replaced by third-party packages ``setuptools`` and
918``packaging``, and most other commonly used APIs are available elsewhere
919in the standard library (such as :mod:`platform`, :mod:`shutil`,
920:mod:`subprocess` or :mod:`sysconfig`). There are no plans to migrate
921any other functionality from ``distutils``, and applications that are
922using other functions should plan to make private copies of the code.
923Refer to :pep:`632` for discussion.
924
Victor Stinner0e2a0f72021-01-09 00:35:01 +0100925The ``bdist_wininst`` command deprecated in Python 3.8 has been removed.
ravcio6cd5b012021-01-21 11:23:46 +0100926The ``bdist_wheel`` command is now recommended to distribute binary packages
Victor Stinner0e2a0f72021-01-09 00:35:01 +0100927on Windows.
928(Contributed by Victor Stinner in :issue:`42802`.)
929
Brett Cannon825ac382020-11-06 18:45:56 -0800930doctest
931-------
932
933When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
934(Contributed by Brett Cannon in :issue:`42133`.)
935
Hai Shic5b049b2020-10-14 23:43:31 +0800936encodings
937---------
Pablo Galindob4f90892021-03-10 00:53:57 +0000938
Hai Shic5b049b2020-10-14 23:43:31 +0800939:func:`encodings.normalize_encoding` now ignores non-ASCII characters.
940(Contributed by Hai Shi in :issue:`39337`.)
941
Ethan Furmanb7751062021-03-30 21:17:26 -0700942enum
943----
944
945:class:`Enum` :func:`__repr__` now returns ``enum_name.member_name`` and
946:func:`__str__` now returns ``member_name``. Stdlib enums available as
947module constants have a :func:`repr` of ``module_name.member_name``.
948(Contributed by Ethan Furman in :issue:`40066`.)
949
Batuhan Taskaya81fe0142021-04-21 23:44:27 +0300950Add :class:`enum.StrEnum` for enums where all members are strings.
951(Contributed by Ethan Furman in :issue:`41816`.)
952
Inada Naoki333d10c2021-04-14 14:12:58 +0900953fileinput
954---------
955
956Added *encoding* and *errors* parameters in :func:`fileinput.input` and
957:class:`fileinput.FileInput`.
958(Contributed by Inada Naoki in :issue:`43712`.)
959
960:func:`fileinput.hook_compressed` now returns :class:`TextIOWrapper` object
961when *mode* is "r" and file is compressed, like uncompressed files.
962(Contributed by Inada Naoki in :issue:`5758`.)
963
Pablo Galindob4f90892021-03-10 00:53:57 +0000964gc
965--
966
967Added audit hooks for :func:`gc.get_objects`, :func:`gc.get_referrers` and
968:func:`gc.get_referents`. (Contributed by Pablo Galindo in :issue:`43439`.)
969
Serhiy Storchaka8a64cea2020-06-18 22:08:27 +0300970glob
971----
972
973Added the *root_dir* and *dir_fd* parameters in :func:`~glob.glob` and
974:func:`~glob.iglob` which allow to specify the root directory for searching.
975(Contributed by Serhiy Storchaka in :issue:`38144`.)
976
Christian Heimesd8389e32021-05-02 16:38:02 +0200977hashlib
978-------
979
980The hashlib module requires OpenSSL 1.1.1 or newer.
981(Contributed by Christian Heimes in :pep:`644` and :issue:`43669`.)
982
983The hashlib module has preliminary support for OpenSSL 3.0.0.
984(Contributed by Christian Heimes in :issue:`38820` and other issues.)
985
986The pure-Python fallback of :func:`~hashlib.pbkdf2_hmac` is deprecated. In
987the future PBKDF2-HMAC will only be available when Python has been built with
988OpenSSL support.
989(Contributed by Christian Heimes in :issue:`43880`.)
990
991hmac
992----
993
994The hmac module now uses OpenSSL's HMAC implementation internally.
995(Contributed by Christian Heimes in :issue:`40645`.)
996
Jason R. Coombs35d50682021-03-14 22:20:49 -0400997importlib.metadata
998------------------
999
1000Feature parity with ``importlib_metadata`` 3.7.
1001
1002:func:`importlib.metadata.entry_points` now provides a nicer experience
1003for selecting entry points by group and name through a new
1004:class:`importlib.metadata.EntryPoints` class.
1005
1006Added :func:`importlib.metadata.packages_distributions` for resolving
1007top-level Python modules and packages to their
1008:class:`importlib.metadata.Distribution`.
1009
Brett Cannon825ac382020-11-06 18:45:56 -08001010inspect
1011-------
1012
1013When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
1014(Contributed by Brett Cannon in :issue:`42133`.)
1015
larryhastings99f71ae2021-04-30 22:55:21 -07001016Added :func:`inspect.get_annotations`, which safely computes the annotations
1017defined on an object. It works around the quirks of accessing the annotations
1018on various types of objects, and makes very few assumptions about the object
1019it examines. :func:`inspect.get_annotations` can also correctly un-stringize
1020stringized annotations. :func:`inspect.get_annotations` is now considered
larryhastings49b26fa2021-05-01 21:19:24 -07001021best practice for accessing the annotations dict defined on any Python object;
1022for more information on best practices for working with annotations, please see
1023:ref:`annotations-howto`.
larryhastings99f71ae2021-04-30 22:55:21 -07001024Relatedly, :func:`inspect.signature`,
1025:func:`inspect.Signature.from_callable`, and ``inspect.Signature.from_function``
1026now call :func:`inspect.get_annotations` to retrieve annotations. This means
1027:func:`inspect.signature` and :func:`inspect.Signature.from_callable` can
1028also now un-stringize stringized annotations.
1029(Contributed by Larry Hastings in :issue:`43817`.)
Batuhan Taskayaeee1c772020-12-24 01:45:13 +03001030
Brett Cannon825ac382020-11-06 18:45:56 -08001031linecache
1032---------
1033
1034When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
1035(Contributed by Brett Cannon in :issue:`42133`.)
1036
pxinwr3405e052020-08-07 13:21:52 +08001037os
1038--
1039
1040Added :func:`os.cpu_count()` support for VxWorks RTOS.
1041(Contributed by Peixing Xin in :issue:`41440`.)
1042
Christian Heimescd9fed62020-11-13 19:48:52 +01001043Added a new function :func:`os.eventfd` and related helpers to wrap the
1044``eventfd2`` syscall on Linux.
1045(Contributed by Christian Heimes in :issue:`41001`.)
1046
Pablo Galindoa57b3d32020-11-17 00:00:38 +00001047Added :func:`os.splice()` that allows to move data between two file
1048descriptors without copying between kernel address space and user
1049address space, where one of the file descriptors must refer to a
1050pipe. (Contributed by Pablo Galindo in :issue:`41625`.)
1051
Dong-hee Naf917c242021-02-04 08:32:55 +09001052Added :data:`~os.O_EVTONLY`, :data:`~os.O_FSYNC`, :data:`~os.O_SYMLINK`
1053and :data:`~os.O_NOFOLLOW_ANY` for macOS.
1054(Contributed by Dong-hee Na in :issue:`43106`.)
1055
Joshua Cannon45205842020-11-20 09:40:39 -06001056pathlib
1057-------
1058
Yaroslav Pankovych79d2e622020-11-23 22:06:22 +02001059Added slice support to :attr:`PurePath.parents <pathlib.PurePath.parents>`.
Joshua Cannon45205842020-11-20 09:40:39 -06001060(Contributed by Joshua Cannon in :issue:`35498`)
1061
Yaroslav Pankovych79d2e622020-11-23 22:06:22 +02001062Added negative indexing support to :attr:`PurePath.parents
1063<pathlib.PurePath.parents>`.
1064(Contributed by Yaroslav Pankovych in :issue:`21041`)
1065
Barney Galef24e2e52021-04-23 21:48:52 +01001066Added :meth:`Path.hardlink_to <pathlib.Path.hardlink_to>` method that
1067supersedes :meth:`~pathlib.Path.link_to`. The new method has the same argument
1068order as :meth:`~pathlib.Path.symlink_to`.
1069(Contributed by Barney Gale in :issue:`39950`.)
1070
Christian Heimes5c73afc2020-11-30 22:34:45 +01001071platform
1072--------
1073
1074Added :func:`platform.freedesktop_os_release()` to retrieve operation system
1075identification from `freedesktop.org os-release
1076<https://www.freedesktop.org/software/systemd/man/os-release.html>`_ standard file.
1077(Contributed by Christian Heimes in :issue:`28468`)
1078
Lewis Gaul11159d22021-04-14 00:59:24 +01001079pprint
1080------
1081
1082:mod:`pprint` can now pretty-print :class:`dataclasses.dataclass` instances.
1083(Contributed by Lewis Gaul in :issue:`43080`.)
1084
Gregory Schevchenkodaff3902020-07-25 22:58:45 +03001085py_compile
1086----------
1087
1088Added ``--quiet`` option to command-line interface of :mod:`py_compile`.
1089(Contributed by Gregory Schevchenko in :issue:`38731`.)
1090
Aviral Srivastava000cde52021-02-01 09:38:44 -08001091pyclbr
1092------
1093
1094Added an ``end_lineno`` attribute to the ``Function`` and ``Class``
1095objects in the tree returned by :func:`pyclbr.readline` and
1096:func:`pyclbr.readline_ex`. It matches the existing (start) ``lineno``.
1097(Contributed by Aviral Srivastava in :issue:`38307`.)
1098
Zackery Spytzdf592732020-10-29 03:44:35 -06001099shelve
1100------
1101
1102The :mod:`shelve` module now uses :data:`pickle.DEFAULT_PROTOCOL` by default
1103instead of :mod:`pickle` protocol ``3`` when creating shelves.
1104(Contributed by Zackery Spytz in :issue:`34204`.)
1105
Tymoteusz Wołodźko09aa6f92021-04-25 13:45:09 +02001106statistics
1107----------
1108
1109Added :func:`~statistics.covariance`, Pearson's
1110:func:`~statistics.correlation`, and simple
1111:func:`~statistics.linear_regression` functions.
1112(Contributed by Tymoteusz Wołodźko in :issue:`38490`.)
1113
Brett Cannon825ac382020-11-06 18:45:56 -08001114site
1115----
1116
1117When a module does not define ``__loader__``, fall back to ``__spec__.loader``.
1118(Contributed by Brett Cannon in :issue:`42133`.)
1119
Christian Heimes03c8ddd2020-11-20 09:26:07 +01001120socket
1121------
1122
1123The exception :exc:`socket.timeout` is now an alias of :exc:`TimeoutError`.
1124(Contributed by Christian Heimes in :issue:`42413`.)
1125
Rui Cunhab05b48d2021-03-20 22:04:56 +00001126Added option to create MPTCP sockets with ``IPPROTO_MPTCP``
1127(Contributed by Rui Cunha in :issue:`43571`.)
1128
Zackery Spytzb2fac1a2021-04-23 22:46:01 -06001129ssl
1130---
1131
Christian Heimesd8389e32021-05-02 16:38:02 +02001132The ssl module requires OpenSSL 1.1.1 or newer.
1133(Contributed by Christian Heimes in :pep:`644` and :issue:`43669`.)
1134
1135The ssl module has preliminary support for OpenSSL 3.0.0 and new option
1136:data:`~ssl.OP_IGNORE_UNEXPECTED_EOF`.
1137(Contributed by Christian Heimes in :issue:`38820`, :issue:`43794`,
1138:issue:`43788`, :issue:`43791`, :issue:`43799`, :issue:`43920`,
1139:issue:`43789`, and :issue:`43811`.)
1140
1141Deprecated function and use of deprecated constants now result in
1142a :exc:`DeprecationWarning`. The following features have been deprecated
1143since Python 3.6, Python 3.7, or OpenSSL 1.1.0:
1144:data:`~ssl.OP_NO_SSLv2`, :data:`~ssl.OP_NO_SSLv3`, :data:`~ssl.OP_NO_TLSv1`,
1145:data:`~ssl.OP_NO_TLSv1_1`, :data:`~ssl.OP_NO_TLSv1_2`,
1146:data:`~ssl.OP_NO_TLSv1_3`, :data:`~ssl.PROTOCOL_SSLv2`,
1147:data:`~ssl.PROTOCOL_SSLv3`, :data:`~ssl.PROTOCOL_SSLv23`,
1148:data:`~ssl.PROTOCOL_TLSv1`, :data:`~ssl.PROTOCOL_TLSv1_1`,
1149:data:`~ssl.PROTOCOL_TLSv1_2`, :data:`~ssl.PROTOCOL_TLS`,
1150:func:`~ssl.wrap_socket`, :func:`~ssl.match_hostname`,
1151:func:`~ssl.RAND_pseudo_bytes`, :func:`~ssl.RAND_egd`,
1152:meth:`ssl.SSLSocket.selected_npn_protocol`,
1153:meth:`ssl.SSLContext.set_npn_protocols`.
1154(Contributed by Christian Heimes in :issue:`43880`.)
1155
Christian Heimese9832522021-05-01 20:53:10 +02001156The ssl module now has more secure default settings. Ciphers without forward
1157secrecy or SHA-1 MAC are disabled by default. Security level 2 prohibits
1158weak RSA, DH, and ECC keys with less than 112 bits of security.
1159:class:`~ssl.SSLContext` defaults to minimum protocol version TLS 1.2.
1160Settings are based on Hynek Schlawack's research.
1161(Contributed by Christian Heimes in :issue:`43998`.)
1162
Christian Heimesd8389e32021-05-02 16:38:02 +02001163The deprecated protocols SSL 3.0, TLS 1.0, and TLS 1.1 are no longer
1164officially supported. Python does not block them actively. However
1165OpenSSL build options, distro configurations, vendor patches, and cipher
1166suites may prevent a successful handshake.
1167
Zackery Spytzb2fac1a2021-04-23 22:46:01 -06001168Add a *timeout* parameter to the :func:`ssl.get_server_certificate` function.
1169(Contributed by Zackery Spytz in :issue:`31870`.)
1170
Christian Heimesd8389e32021-05-02 16:38:02 +02001171The ssl module uses heap-types and multi-phase initialization.
1172(Contributed by Christian Heimes in :issue:`42333`.)
1173
1174A new verify flag :data:`~ssl.VERIFY_X509_PARTIAL_CHAIN` has been added.
1175(Contributed by l0x in :issue:`40849`.)
1176
Erlend Egeberg Aasland7244c002021-04-27 01:16:46 +02001177sqlite3
1178-------
1179
1180Add audit events for :func:`~sqlite3.connect/handle`,
1181:meth:`~sqlite3.Connection.enable_load_extension`, and
1182:meth:`~sqlite3.Connection.load_extension`.
1183(Contributed by Erlend E. Aasland in :issue:`43762`.)
1184
Victor Stinnerdd8a93e2020-06-30 00:49:03 +02001185sys
1186---
1187
1188Add :data:`sys.orig_argv` attribute: the list of the original command line
1189arguments passed to the Python executable.
1190(Contributed by Victor Stinner in :issue:`23427`.)
1191
Victor Stinner9852cb32021-01-25 23:12:50 +01001192Add :data:`sys.stdlib_module_names`, containing the list of the standard library
Victor Stinnerdb584bd2021-01-25 13:24:42 +01001193module names.
1194(Contributed by Victor Stinner in :issue:`42955`.)
1195
Antoine Pitrouba251c22021-03-11 23:35:45 +01001196_thread
1197-------
1198
1199:func:`_thread.interrupt_main` now takes an optional signal number to
1200simulate (the default is still :data:`signal.SIGINT`).
1201(Contributed by Antoine Pitrou in :issue:`43356`.)
1202
Mario Corchero0001a1b2020-11-04 10:27:43 +01001203threading
1204---------
1205
1206Added :func:`threading.gettrace` and :func:`threading.getprofile` to
1207retrieve the functions set by :func:`threading.settrace` and
1208:func:`threading.setprofile` respectively.
1209(Contributed by Mario Corchero in :issue:`42251`.)
1210
Mario Corchero750c5ab2020-11-12 18:27:44 +01001211Add :data:`threading.__excepthook__` to allow retrieving the original value
1212of :func:`threading.excepthook` in case it is set to a broken or a different
1213value.
1214(Contributed by Mario Corchero in :issue:`42308`.)
1215
Zackery Spytz91e93792020-11-05 15:18:44 -07001216traceback
1217---------
1218
1219The :func:`~traceback.format_exception`,
1220:func:`~traceback.format_exception_only`, and
1221:func:`~traceback.print_exception` functions can now take an exception object
1222as a positional-only argument.
1223(Contributed by Zackery Spytz and Matthias Bussonnier in :issue:`26389`.)
1224
Bas van Beek0d0e9fe2020-09-22 17:55:34 +02001225types
1226-----
1227
1228Reintroduced the :data:`types.EllipsisType`, :data:`types.NoneType`
1229and :data:`types.NotImplementedType` classes, providing a new set
1230of types readily interpretable by type checkers.
1231(Contributed by Bas van Beek in :issue:`41810`.)
1232
kj46873382020-11-19 11:44:24 +07001233typing
1234------
1235
larryhastings99f71ae2021-04-30 22:55:21 -07001236For major changes, see `New Features Related to Type Hints`_.
Ken Jin727a68b2021-03-03 08:52:03 +08001237
kj46873382020-11-19 11:44:24 +07001238The behavior of :class:`typing.Literal` was changed to conform with :pep:`586`
1239and to match the behavior of static type checkers specified in the PEP.
1240
12411. ``Literal`` now de-duplicates parameters.
12422. Equality comparisons between ``Literal`` objects are now order independent.
12433. ``Literal`` comparisons now respects types. For example,
1244 ``Literal[0] == Literal[False]`` previously evaluated to ``True``. It is
1245 now ``False``. To support this change, the internally used type cache now
1246 supports differentiating types.
12474. ``Literal`` objects will now raise a :exc:`TypeError` exception during
1248 equality comparisons if one of their parameters are not :term:`immutable`.
1249 Note that declaring ``Literal`` with mutable parameters will not throw
1250 an error::
1251
1252 >>> from typing import Literal
1253 >>> Literal[{0}]
1254 >>> Literal[{0}] == Literal[{False}]
1255 Traceback (most recent call last):
1256 File "<stdin>", line 1, in <module>
1257 TypeError: unhashable type: 'set'
1258
1259(Contributed by Yurii Karabas in :issue:`42345`.)
1260
Batuhan Taskaya81fe0142021-04-21 23:44:27 +03001261Add new function :func:`typing.is_typeddict` to introspect if an annotation
1262is a :class:`typing.TypedDict`.
1263(Contributed by Patrick Reader in :issue:`41792`)
1264
Mark Dickinsonc8c70e72020-09-19 21:38:11 +01001265unittest
1266--------
1267
1268Add new method :meth:`~unittest.TestCase.assertNoLogs` to complement the
1269existing :meth:`~unittest.TestCase.assertLogs`. (Contributed by Kit Yan Choi
1270in :issue:`39385`.)
1271
Adam Goldschmidtfcbe0cb2021-02-15 00:41:57 +02001272urllib.parse
1273------------
1274
1275Python versions earlier than Python 3.10 allowed using both ``;`` and ``&`` as
1276query parameter separators in :func:`urllib.parse.parse_qs` and
1277:func:`urllib.parse.parse_qsl`. Due to security concerns, and to conform with
1278newer W3C recommendations, this has been changed to allow only a single
1279separator key, with ``&`` as the default. This change also affects
1280:func:`cgi.parse` and :func:`cgi.parse_multipart` as they use the affected
1281functions internally. For more details, please see their respective
1282documentation.
1283(Contributed by Adam Goldschmidt, Senthil Kumaran and Ken Jin in :issue:`42967`.)
1284
Zackery Spytze28b8c92020-08-09 04:50:53 -06001285xml
1286---
1287
1288Add a :class:`~xml.sax.handler.LexicalHandler` class to the
1289:mod:`xml.sax.handler` module.
1290(Contributed by Jonathan Gossage and Zackery Spytz in :issue:`35018`.)
1291
Brett Cannond2e94bb2020-11-13 15:14:58 -08001292zipimport
1293---------
1294Add methods related to :pep:`451`: :meth:`~zipimport.zipimporter.find_spec`,
1295:meth:`zipimport.zipimporter.create_module`, and
1296:meth:`zipimport.zipimporter.exec_module`.
Batuhan Taskaya81fe0142021-04-21 23:44:27 +03001297(Contributed by Brett Cannon in :issue:`42131`.)
1298
1299Add :meth:`~zipimport.zipimporter.invalidate_caches` method.
1300(Contributed by Desmond Cheong in :issue:`14678`.)
Brett Cannond2e94bb2020-11-13 15:14:58 -08001301
Serhiy Storchaka8a64cea2020-06-18 22:08:27 +03001302
Pablo Galindod4fe0982020-05-19 03:33:01 +01001303Optimizations
1304=============
1305
Serhiy Storchaka12f43342020-07-20 15:53:55 +03001306* Constructors :func:`str`, :func:`bytes` and :func:`bytearray` are now faster
1307 (around 30--40% for small objects).
1308 (Contributed by Serhiy Storchaka in :issue:`41334`.)
1309
Victor Stinner2c2a4f32020-06-18 01:20:51 +02001310* The :mod:`runpy` module now imports fewer modules.
Victor Stinnercd27af72021-03-23 20:22:40 +01001311 The ``python3 -m module-name`` command startup time is 1.4x faster in
1312 average. On Linux, ``python3 -I -m module-name`` imports 69 modules on Python
1313 3.9, whereas it only imports 51 modules (-18) on Python 3.10.
1314 (Contributed by Victor Stinner in :issue:`41006` and :issue:`41718`.)
Victor Stinner4c18fc82020-06-17 23:58:58 +02001315
Pablo Galindo9e8fe192021-01-03 04:37:46 +00001316* The ``LOAD_ATTR`` instruction now uses new "per opcode cache" mechanism. It
Pablo Galindoa776da92021-01-31 22:55:48 +00001317 is about 36% faster now for regular attributes and 44% faster for slots.
1318 (Contributed by Pablo Galindo and Yury Selivanov in :issue:`42093` and Guido
1319 van Rossum in :issue:`42927`, based on ideas implemented originally in PyPy
1320 and MicroPython.)
Pablo Galindod4fe0982020-05-19 03:33:01 +01001321
Victor Stinner85918e42021-04-12 23:27:35 +02001322* When building Python with :option:`--enable-optimizations` now
Pablo Galindob451b0e2020-10-21 22:46:52 +01001323 ``-fno-semantic-interposition`` is added to both the compile and link line.
Victor Stinner85918e42021-04-12 23:27:35 +02001324 This speeds builds of the Python interpreter created with :option:`--enable-shared`
Pablo Galindob451b0e2020-10-21 22:46:52 +01001325 with ``gcc`` by up to 30%. See `this article
1326 <https://developers.redhat.com/blog/2020/06/25/red-hat-enterprise-linux-8-2-brings-faster-python-3-8-run-speeds/>`_
1327 for more details. (Contributed by Victor Stinner and Pablo Galindo in
Brett Cannon2de50972020-12-04 15:39:21 -08001328 :issue:`38980`.)
1329
Ma Linf9bedb62021-04-28 14:58:54 +08001330* Use a new output buffer management code for :mod:`bz2` / :mod:`lzma` /
1331 :mod:`zlib` modules, and add ``.readall()`` function to
1332 ``_compression.DecompressReader`` class. bz2 decompression 1.09x ~ 1.17x
1333 faster, lzma decompression 1.20x ~ 1.32x faster, ``GzipFile.read(-1)`` 1.11x
1334 ~ 1.18x faster. (Contributed by Ma Lin, reviewed by Gregory P. Smith, in :issue:`41486`)
1335
larryhastings99f71ae2021-04-30 22:55:21 -07001336* When using stringized annotations, annotations dicts for functions are no longer
1337 created when the function is created. Instead, they're stored as a tuple of
1338 strings, and the function object lazily converts this into the annotations dict
1339 on demand. This optimization cuts the CPU time needed to define an annotated
1340 function by half.
1341 (Contributed by Yurii Karabas and Inada Naoki in :issue:`42202`)
Yurii Karabas73019792020-11-25 12:43:18 +02001342
Dennis Sweeneye8f5ddd2021-02-28 16:32:04 -05001343* Substring search functions such as ``str1 in str2`` and ``str2.find(str1)``
1344 now sometimes use Crochemore & Perrin's "Two-Way" string searching
1345 algorithm to avoid quadratic behavior on long strings. (Contributed
1346 by Dennis Sweeney in :issue:`41972`)
1347
Pablo Galindoa054f6b2021-03-24 00:04:52 +00001348* Added micro-optimizations to ``_PyType_Lookup()`` to improve type attribute cache lookup
1349 performance in the common case of cache hits. This makes the interpreter 1.04 times faster
1350 in average (Contributed by Dino Viehland in :issue:`43452`)
1351
Dong-hee Naefccff92021-04-07 00:43:59 +09001352* Following built-in functions now support the faster :pep:`590` vectorcall calling convention:
1353 :func:`map`, :func:`filter`, :func:`reversed`, :func:`bool` and :func:`float`.
1354 (Contributed by Dong-hee Na and Jeroen Demeyerin in :issue:`43575`, :issue:`43287`, :issue:`41922`, :issue:`41873` and :issue:`41870`)
1355
Inada Naoki695d47b2021-04-14 08:22:49 +09001356* :class:`BZ2File` performance is improved by removing internal ``RLock``.
1357 This makes :class:`BZ2File` thread unsafe in the face of multiple simultaneous
1358 readers or writers, just like its equivalent classes in :mod:`gzip` and
1359 :mod:`lzma` have always been. (Contributed by Inada Naoki in :issue:`43785`).
1360
Pablo Galindod4fe0982020-05-19 03:33:01 +01001361Deprecated
1362==========
1363
Brett Cannon04523c52020-10-23 18:10:54 -07001364* Starting in this release, there will be a concerted effort to begin
1365 cleaning up old import semantics that were kept for Python 2.7
1366 compatibility. Specifically,
1367 :meth:`~importlib.abc.PathEntryFinder.find_loader`/:meth:`~importlib.abc.Finder.find_module`
1368 (superseded by :meth:`~importlib.abc.Finder.find_spec`),
1369 :meth:`~importlib.abc.Loader.load_module`
1370 (superseded by :meth:`~importlib.abc.Loader.exec_module`),
1371 :meth:`~importlib.abc.Loader.module_repr` (which the import system
1372 takes care of for you), the ``__package__`` attribute
1373 (superseded by ``__spec__.parent``), the ``__loader__`` attribute
1374 (superseded by ``__spec__.loader``), and the ``__cached__`` attribute
1375 (superseded by ``__spec__.cached``) will slowly be removed (as well
1376 as other classes and methods in :mod:`importlib`).
1377 :exc:`ImportWarning` and/or :exc:`DeprecationWarning` will be raised
1378 as appropriate to help identify code which needs updating during
1379 this transition.
1380
Steve Dower62949f62021-01-29 21:48:55 +00001381* The entire ``distutils`` namespace is deprecated, to be removed in
1382 Python 3.12. Refer to the :ref:`module changes <distutils-deprecated>`
1383 section for more information.
1384
Serhiy Storchakaf066bd92021-01-25 23:02:04 +02001385* Non-integer arguments to :func:`random.randrange` are deprecated.
1386 The :exc:`ValueError` is deprecated in favor of a :exc:`TypeError`.
1387 (Contributed by Serhiy Storchaka and Raymond Hettinger in :issue:`37319`.)
1388
Brett Cannon2de50972020-12-04 15:39:21 -08001389* The various ``load_module()`` methods of :mod:`importlib` have been
1390 documented as deprecated since Python 3.6, but will now also trigger
1391 a :exc:`DeprecationWarning`. Use
1392 :meth:`~importlib.abc.Loader.exec_module` instead.
1393 (Contributed by Brett Cannon in :issue:`26131`.)
1394
1395* :meth:`zimport.zipimporter.load_module` has been deprecated in
1396 preference for :meth:`~zipimport.zipimporter.exec_module`.
1397 (Contributed by Brett Cannon in :issue:`26131`.)
1398
1399* The use of :meth:`~importlib.abc.Loader.load_module` by the import
1400 system now triggers an :exc:`ImportWarning` as
1401 :meth:`~importlib.abc.Loader.exec_module` is preferred.
1402 (Contributed by Brett Cannon in :issue:`26131`.)
1403
Brett Cannona7ff6df2021-03-30 08:43:03 -07001404* The use of :meth:`importlib.abc.MetaPathFinder.find_module` and
1405 :meth:`importlib.abc.PathEntryFinder.find_module` by the import system now
1406 trigger an :exc:`ImportWarning` as
1407 :meth:`importlib.abc.MetaPathFinder.find_spec` and
1408 :meth:`importlib.abc.PathEntryFinder.find_spec`
1409 are preferred, respectively. You can use
1410 :func:`importlib.util.spec_from_loader` to help in porting.
Brett Cannonf97dc802021-04-02 12:35:32 -07001411 (Contributed by Brett Cannon in :issue:`42134`.)
1412
1413* The use of :meth:`importlib.abc.PathEntryFinder.find_loader` by the import
1414 system now triggers an :exc:`ImportWarning` as
1415 :meth:`importlib.abc.PathEntryFinder.find_spec` is preferred. You can use
1416 :func:`importlib.util.spec_from_loader` to help in porting.
1417 (Contributed by Brett Cannon in :issue:`43672`.)
Brett Cannona7ff6df2021-03-30 08:43:03 -07001418
Brett Cannon57c6cb52021-04-06 08:56:57 -07001419* The various implementations of
1420 :meth:`importlib.abc.MetaPathFinder.find_module` (
1421 :meth:`importlib.machinery.BuiltinImporter.find_module`,
1422 :meth:`importlib.machinery.FrozenImporter.find_module`,
1423 :meth:`importlib.machinery.WindowsRegistryFinder.find_module`,
1424 :meth:`importlib.machinery.PathFinder.find_module`,
1425 :meth:`importlib.abc.MetaPathFinder.find_module`),
1426 :meth:`importlib.abc.PathEntryFinder.find_module` (
1427 :meth:`importlib.machinery.FileFinder.find_module`,
1428 ), and
1429 :meth:`importlib.abc.PathEntryFinder.find_loader` (
1430 :meth:`importlib.machinery.FileFinder.find_loader`
1431 ) now raise :exc:`DeprecationWarning` and are slated for removal in
1432 Python 3.12 (previously they were documented as deprecated in Python 3.4).
1433 (Contributed by Brett Cannon in :issue:`42135`.)
1434
1435* :class:`importlib.abc.Finder` is deprecated (including its sole method,
1436 :meth:`~importlib.abc.Finder.find_module`). Both
1437 :class:`importlib.abc.MetaPathFinder` and :class:`importlib.abc.PathEntryFinder`
1438 no longer inherit from the class. Users should inherit from one of these two
1439 classes as appropriate instead.
1440 (Contributed by Brett Cannon in :issue:`42135`.)
1441
1442* The deprecations of :mod:`imp`, :func:`importlib.find_loader`,
1443 :func:`importlib.util.set_package_wrapper`,
1444 :func:`importlib.util.set_loader_wrapper`,
1445 :func:`importlib.util.module_for_loader`,
1446 :class:`pkgutil.ImpImporter`, and
1447 :class:`pkgutil.ImpLoader` have all been updated to list Python 3.12 as the
1448 slated version of removal (they began raising :exc:`DeprecationWarning` in
1449 previous versions of Python).
1450 (Contributed by Brett Cannon in :issue:`43720`.)
1451
Brett Cannon9cb31d62021-03-24 08:26:56 -07001452* The import system now uses the ``__spec__`` attribute on modules before
1453 falling back on :meth:`~importlib.abc.Loader.module_repr` for a module's
1454 ``__repr__()`` method. Removal of the use of ``module_repr()`` is scheduled
1455 for Python 3.12.
1456 (Contributed by Brett Cannon in :issue:`42137`.)
1457
Brett Cannon18990872021-03-26 11:55:07 -07001458* :meth:`importlib.abc.Loader.module_repr`,
1459 :meth:`importlib.machinery.FrozenLoader.module_repr`, and
1460 :meth:`importlib.machinery.BuiltinLoader.module_repr` are deprecated and
1461 slated for removal in Python 3.12.
1462 (Contributed by Brett Cannon in :issue:`42136`.)
1463
Erlend Egeberg Aaslanda1f401a2020-11-17 16:55:12 +01001464* ``sqlite3.OptimizedUnicode`` has been undocumented and obsolete since Python
1465 3.3, when it was made an alias to :class:`str`. It is now deprecated,
1466 scheduled for removal in Python 3.12.
1467 (Contributed by Erlend E. Aasland in :issue:`42264`.)
1468
Serhiy Storchaka172c0f22021-04-25 13:40:44 +03001469* :func:`asyncio.get_event_loop` emits now a deprecation warning if there is
1470 no running event loop. In future it will be an alias of
1471 :func:`~asyncio.get_running_loop`.
1472 :mod:`asyncio` functions which implicitly create a :class:`~asyncio.Future`
1473 or :class:`~asyncio.Task` objects emit now
1474 a deprecation warning if there is no running event loop and no explicit
1475 *loop* argument is passed: :func:`~asyncio.ensure_future`,
1476 :func:`~asyncio.wrap_future`, :func:`~asyncio.gather`,
1477 :func:`~asyncio.shield`, :func:`~asyncio.as_completed` and constructors of
1478 :class:`~asyncio.Future`, :class:`~asyncio.Task`,
1479 :class:`~asyncio.StreamReader`, :class:`~asyncio.StreamReaderProtocol`.
1480 (Contributed by Serhiy Storchaka in :issue:`39529`.)
1481
Erlend Egeberg Aaslandddb5e112021-01-06 01:36:04 +01001482* The undocumented built-in function ``sqlite3.enable_shared_cache`` is now
1483 deprecated, scheduled for removal in Python 3.12. Its use is strongly
1484 discouraged by the SQLite3 documentation. See `the SQLite3 docs
Tom Forbes749d40a2021-02-10 17:56:16 +00001485 <https://sqlite.org/c3ref/enable_shared_cache.html>`_ for more details.
Erlend Egeberg Aaslandddb5e112021-01-06 01:36:04 +01001486 If shared cache must be used, open the database in URI mode using the
1487 ``cache=shared`` query parameter.
1488 (Contributed by Erlend E. Aasland in :issue:`24464`.)
1489
Jelle Zijlstra9825bdf2021-04-12 01:42:53 -07001490* The following ``threading`` methods are now deprecated:
1491
1492 * ``threading.currentThread`` => :func:`threading.current_thread`
1493
1494 * ``threading.activeCount`` => :func:`threading.active_count`
1495
1496 * ``threading.Condition.notifyAll`` =>
1497 :meth:`threading.Condition.notify_all`
1498
1499 * ``threading.Event.isSet`` => :meth:`threading.Event.is_set`
1500
1501 * ``threading.Thread.setName`` => :attr:`threading.Thread.name`
1502
1503 * ``threading.thread.getName`` => :attr:`threading.Thread.name`
1504
1505 * ``threading.Thread.isDaemon`` => :attr:`threading.Thread.daemon`
1506
1507 * ``threading.Thread.setDaemon`` => :attr:`threading.Thread.daemon`
1508
1509 (Contributed by Jelle Zijlstra in :issue:`21574`.)
1510
Barney Galef24e2e52021-04-23 21:48:52 +01001511* :meth:`pathlib.Path.link_to` is deprecated and slated for removal in
1512 Python 3.12. Use :meth:`pathlib.Path.hardlink_to` instead.
1513 (Contributed by Barney Gale in :issue:`39950`.)
1514
Inada Naokie52ab422021-04-29 11:36:04 +09001515* ``cgi.log()`` is deprecated and slated for for removal in Python 3.12.
1516 (Contributed by Inada Naoki in :issue:`41139`.)
1517
Pablo Galindod4fe0982020-05-19 03:33:01 +01001518
Pablo Galindod4fe0982020-05-19 03:33:01 +01001519Removed
1520=======
1521
Serhiy Storchakae2ec0b22020-10-09 14:14:37 +03001522* Removed special methods ``__int__``, ``__float__``, ``__floordiv__``,
1523 ``__mod__``, ``__divmod__``, ``__rfloordiv__``, ``__rmod__`` and
1524 ``__rdivmod__`` of the :class:`complex` class. They always raised
1525 a :exc:`TypeError`.
1526 (Contributed by Serhiy Storchaka in :issue:`41974`.)
1527
Berker Peksagd4d127f2020-07-16 09:38:58 +03001528* The ``ParserBase.error()`` method from the private and undocumented ``_markupbase``
1529 module has been removed. :class:`html.parser.HTMLParser` is the only subclass of
1530 ``ParserBase`` and its ``error()`` implementation has already been removed in
1531 Python 3.5.
1532 (Contributed by Berker Peksag in :issue:`31844`.)
1533
Victor Stinner84f73822020-10-27 04:36:22 +01001534* Removed the ``unicodedata.ucnhash_CAPI`` attribute which was an internal
1535 PyCapsule object. The related private ``_PyUnicode_Name_CAPI`` structure was
1536 moved to the internal C API.
1537 (Contributed by Victor Stinner in :issue:`42157`.)
1538
Lysandros Nikolaouc26d5912020-11-16 20:46:37 +02001539* Removed the ``parser`` module, which was deprecated in 3.9 due to the
1540 switch to the new PEG parser, as well as all the C source and header files
1541 that were only being used by the old parser, including ``node.h``, ``parser.h``,
1542 ``graminit.h`` and ``grammar.h``.
1543
1544* Removed the Public C API functions :c:func:`PyParser_SimpleParseStringFlags`,
1545 :c:func:`PyParser_SimpleParseStringFlagsFilename`,
1546 :c:func:`PyParser_SimpleParseFileFlags` and :c:func:`PyNode_Compile`
1547 that were deprecated in 3.9 due to the switch to the new PEG parser.
1548
Dong-hee Nabe319c02020-11-25 22:17:30 +09001549* Removed the ``formatter`` module, which was deprecated in Python 3.4.
1550 It is somewhat obsolete, little used, and not tested. It was originally
1551 scheduled to be removed in Python 3.6, but such removals were delayed until
1552 after Python 2.7 EOL. Existing users should copy whatever classes they use
1553 into their code.
1554 (Contributed by Dong-hee Na and Terry J. Reedy in :issue:`42299`.)
Pablo Galindod4fe0982020-05-19 03:33:01 +01001555
Hai Shi0f91f582020-12-08 22:42:42 +08001556* Removed the :c:func:`PyModule_GetWarningsModule` function that was useless
1557 now due to the _warnings module was converted to a builtin module in 2.6.
1558 (Contributed by Hai Shi in :issue:`42599`.)
1559
Hugo van Kemenadec47c78b2021-01-13 01:16:37 +02001560* Remove deprecated aliases to :ref:`collections-abstract-base-classes` from
1561 the :mod:`collections` module.
1562 (Contributed by Victor Stinner in :issue:`37324`.)
1563
Ken Jindcea78f2021-01-20 16:16:12 -08001564* The ``loop`` parameter has been removed from most of :mod:`asyncio`\ 's
1565 :doc:`high-level API <../library/asyncio-api-index>` following deprecation
1566 in Python 3.8. The motivation behind this change is multifold:
1567
1568 1. This simplifies the high-level API.
1569 2. The functions in the high-level API have been implicitly getting the
1570 current thread's running event loop since Python 3.7. There isn't a need to
1571 pass the event loop to the API in most normal use cases.
1572 3. Event loop passing is error-prone especially when dealing with loops
1573 running in different threads.
1574
1575 Note that the low-level API will still accept ``loop``.
1576 See `Changes in the Python API`_ for examples of how to replace existing code.
1577
1578 (Contributed by Yurii Karabas, Andrew Svetlov, Yury Selivanov and Kyle Stanley
1579 in :issue:`42392`.)
1580
Hai Shi0f91f582020-12-08 22:42:42 +08001581
Pablo Galindod4fe0982020-05-19 03:33:01 +01001582Porting to Python 3.10
1583======================
1584
1585This section lists previously described changes and other bugfixes
1586that may require changes to your code.
1587
1588
Zackery Spytz91e93792020-11-05 15:18:44 -07001589Changes in the Python API
1590-------------------------
1591
1592* The *etype* parameters of the :func:`~traceback.format_exception`,
1593 :func:`~traceback.format_exception_only`, and
1594 :func:`~traceback.print_exception` functions in the :mod:`traceback` module
1595 have been renamed to *exc*.
1596 (Contributed by Zackery Spytz and Matthias Bussonnier in :issue:`26389`.)
1597
Victor Stinner357704c2020-12-14 23:07:54 +01001598* :mod:`atexit`: At Python exit, if a callback registered with
1599 :func:`atexit.register` fails, its exception is now logged. Previously, only
1600 some exceptions were logged, and the last exception was always silently
1601 ignored.
1602 (Contributed by Victor Stinner in :issue:`42639`.)
1603
kjd75f6f72020-12-19 01:39:26 +08001604* :class:`collections.abc.Callable` generic now flattens type parameters, similar
1605 to what :data:`typing.Callable` currently does. This means that
1606 ``collections.abc.Callable[[int, str], str]`` will have ``__args__`` of
1607 ``(int, str, str)``; previously this was ``([int, str], str)``. Code which
1608 accesses the arguments via :func:`typing.get_args` or ``__args__`` need to account
1609 for this change. Furthermore, :exc:`TypeError` may be raised for invalid forms
1610 of parameterizing :class:`collections.abc.Callable` which may have passed
1611 silently in Python 3.9.
1612 (Contributed by Ken Jin in :issue:`42195`.)
Victor Stinner357704c2020-12-14 23:07:54 +01001613
Erlend Egeberg Aaslandf4936ad2020-12-31 14:16:50 +01001614* :meth:`socket.htons` and :meth:`socket.ntohs` now raise :exc:`OverflowError`
1615 instead of :exc:`DeprecationWarning` if the given parameter will not fit in
1616 a 16-bit unsigned integer.
1617 (Contributed by Erlend E. Aasland in :issue:`42393`.)
1618
Ken Jindcea78f2021-01-20 16:16:12 -08001619* The ``loop`` parameter has been removed from most of :mod:`asyncio`\ 's
1620 :doc:`high-level API <../library/asyncio-api-index>` following deprecation
1621 in Python 3.8.
1622
1623 A coroutine that currently look like this::
1624
1625 async def foo(loop):
1626 await asyncio.sleep(1, loop=loop)
1627
1628 Should be replaced with this::
1629
1630 async def foo():
1631 await asyncio.sleep(1)
1632
1633 If ``foo()`` was specifically designed *not* to run in the current thread's
1634 running event loop (e.g. running in another thread's event loop), consider
1635 using :func:`asyncio.run_coroutine_threadsafe` instead.
1636
1637 (Contributed by Yurii Karabas, Andrew Svetlov, Yury Selivanov and Kyle Stanley
1638 in :issue:`42392`.)
Erlend Egeberg Aaslandf4936ad2020-12-31 14:16:50 +01001639
Victor Stinner46496f92021-02-20 15:17:18 +01001640* The :data:`types.FunctionType` constructor now inherits the current builtins
1641 if the *globals* dictionary has no ``"__builtins__"`` key, rather than using
1642 ``{"None": None}`` as builtins: same behavior as :func:`eval` and
1643 :func:`exec` functions. Defining a function with ``def function(...): ...``
1644 in Python is not affected, globals cannot be overriden with this syntax: it
1645 also inherits the current builtins.
1646 (Contributed by Victor Stinner in :issue:`42990`.)
1647
Yurii Karabas73019792020-11-25 12:43:18 +02001648CPython bytecode changes
1649========================
1650
larryhastings99f71ae2021-04-30 22:55:21 -07001651* The ``MAKE_FUNCTION`` instruction now accepts either a dict or a tuple of
1652 strings as the function's annotations.
Yurii Karabas73019792020-11-25 12:43:18 +02001653 (Contributed by Yurii Karabas and Inada Naoki in :issue:`42202`)
Dong-hee Naad3252b2020-05-26 01:52:54 +09001654
1655Build Changes
1656=============
1657
Christian Heimes39258d32021-04-17 11:36:35 +02001658* :pep:`644`: Python now requires OpenSSL 1.1.1 or newer. OpenSSL 1.0.2 is no
1659 longer supported.
1660 (Contributed by Christian Heimes in :issue:`43669`.)
1661
Victor Stinner7ab92d52020-06-16 00:54:44 +02001662* The C99 functions :c:func:`snprintf` and :c:func:`vsnprintf` are now required
1663 to build Python.
1664 (Contributed by Victor Stinner in :issue:`36020`.)
1665
Erlend Egeberg Aaslandcf0b2392021-01-06 01:02:43 +01001666* :mod:`sqlite3` requires SQLite 3.7.15 or higher. (Contributed by Sergey Fedoseev
1667 and Erlend E. Aasland :issue:`40744` and :issue:`40810`.)
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +02001668
Victor Stinner357704c2020-12-14 23:07:54 +01001669* The :mod:`atexit` module must now always be built as a built-in module.
1670 (Contributed by Victor Stinner in :issue:`42639`.)
Erlend Egeberg Aasland207c3212020-09-07 23:26:54 +02001671
Victor Stinner85918e42021-04-12 23:27:35 +02001672* Added :option:`--disable-test-modules` option to the ``configure`` script:
pxinwr277ce302020-12-30 20:50:39 +08001673 don't build nor install test modules.
1674 (Contributed by Xavier de Gaye, Thomas Petazzoni and Peixing Xin in :issue:`27640`.)
1675
Victor Stinner85918e42021-04-12 23:27:35 +02001676* Add :option:`--with-wheel-pkg-dir=PATH option <--with-wheel-pkg-dir>`
1677 to the ``./configure`` script. If
Victor Stinner75e59a92021-01-20 17:07:21 +01001678 specified, the :mod:`ensurepip` module looks for ``setuptools`` and ``pip``
1679 wheel packages in this directory: if both are present, these wheel packages
1680 are used instead of ensurepip bundled wheel packages.
1681
1682 Some Linux distribution packaging policies recommend against bundling
1683 dependencies. For example, Fedora installs wheel packages in the
1684 ``/usr/share/python-wheels/`` directory and don't install the
1685 ``ensurepip._bundled`` package.
1686
1687 (Contributed by Victor Stinner in :issue:`42856`.)
1688
Victor Stinner85918e42021-04-12 23:27:35 +02001689* Add a new :option:`configure --without-static-libpython option
1690 <--without-static-libpython>` to not build the ``libpythonMAJOR.MINOR.a``
1691 static library and not install the ``python.o`` object file.
Victor Stinner801bb0b2021-02-17 11:14:42 +01001692
1693 (Contributed by Victor Stinner in :issue:`43103`.)
1694
Ned Deilya65b0502021-03-01 00:27:20 -05001695* The ``configure`` script now uses the ``pkg-config`` utility, if available,
1696 to detect the location of Tcl/Tk headers and libraries. As before, those
Victor Stinner85918e42021-04-12 23:27:35 +02001697 locations can be explicitly specified with the :option:`--with-tcltk-includes`
1698 and :option:`--with-tcltk-libs` configuration options.
Ned Deilya65b0502021-03-01 00:27:20 -05001699 (Contributed by Manolis Stamatogiannakis in :issue:`42603`.)
1700
Victor Stinner85918e42021-04-12 23:27:35 +02001701* Add :option:`--with-openssl-rpath` option to ``configure`` script. The option
Christian Heimes32eba612021-03-19 10:29:25 +01001702 simplifies building Python with a custom OpenSSL installation, e.g.
1703 ``./configure --with-openssl=/path/to/openssl --with-openssl-rpath=auto``.
1704 (Contributed by Christian Heimes in :issue:`43466`.)
1705
1706
Dong-hee Naad3252b2020-05-26 01:52:54 +09001707C API Changes
1708=============
1709
1710New Features
1711------------
1712
Victor Stinnerdd8a93e2020-06-30 00:49:03 +02001713* The result of :c:func:`PyNumber_Index` now always has exact type :class:`int`.
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +03001714 Previously, the result could have been an instance of a subclass of ``int``.
1715 (Contributed by Serhiy Storchaka in :issue:`40792`.)
1716
Victor Stinnerdd8a93e2020-06-30 00:49:03 +02001717* Add a new :c:member:`~PyConfig.orig_argv` member to the :c:type:`PyConfig`
1718 structure: the list of the original command line arguments passed to the
1719 Python executable.
1720 (Contributed by Victor Stinner in :issue:`23427`.)
Dong-hee Naad3252b2020-05-26 01:52:54 +09001721
Zackery Spytz2e4dd332020-09-23 12:43:45 -06001722* The :c:func:`PyDateTime_DATE_GET_TZINFO` and
1723 :c:func:`PyDateTime_TIME_GET_TZINFO` macros have been added for accessing
1724 the ``tzinfo`` attributes of :class:`datetime.datetime` and
1725 :class:`datetime.time` objects.
1726 (Contributed by Zackery Spytz in :issue:`30155`.)
1727
Hai Shid332e7b2020-09-29 05:41:11 +08001728* Add a :c:func:`PyCodec_Unregister` function to unregister a codec
1729 search function.
1730 (Contributed by Hai Shi in :issue:`41842`.)
1731
Vladimir Matveev24a54c02020-10-12 12:10:42 -07001732* The :c:func:`PyIter_Send` function was added to allow
Vladimir Matveev037245c2020-10-09 17:15:15 -07001733 sending value into iterator without raising ``StopIteration`` exception.
1734 (Contributed by Vladimir Matveev in :issue:`41756`.)
1735
Alex Gaynor3a8fdb22020-10-19 18:17:50 -04001736* Added :c:func:`PyUnicode_AsUTF8AndSize` to the limited C API.
1737 (Contributed by Alex Gaynor in :issue:`41784`.)
1738
Victor Stinner80218752020-11-04 13:59:15 +01001739* Added :c:func:`PyModule_AddObjectRef` function: similar to
Victor Stinner95ce7cd2020-11-11 01:52:26 +01001740 :c:func:`PyModule_AddObject` but don't steal a reference to the value on
Victor Stinner80218752020-11-04 13:59:15 +01001741 success.
1742 (Contributed by Victor Stinner in :issue:`1635741`.)
1743
Victor Stinner53a03aa2020-11-05 15:02:12 +01001744* Added :c:func:`Py_NewRef` and :c:func:`Py_XNewRef` functions to increment the
1745 reference count of an object and return the object.
1746 (Contributed by Victor Stinner in :issue:`42262`.)
1747
Serhiy Storchaka686c2032020-11-22 13:25:02 +02001748* The :c:func:`PyType_FromSpecWithBases` and :c:func:`PyType_FromModuleAndSpec`
1749 functions now accept a single class as the *bases* argument.
1750 (Contributed by Serhiy Storchaka in :issue:`42423`.)
1751
Hai Shi88c2cfd2020-11-07 00:04:47 +08001752* The :c:func:`PyType_FromModuleAndSpec` function now accepts NULL ``tp_doc``
1753 slot.
1754 (Contributed by Hai Shi in :issue:`41832`.)
1755
Victor Stinner5bd06192021-04-29 10:26:34 +02001756* The :c:func:`PyType_GetSlot` function can accept
1757 :ref:`static types <static-types>`.
Hai Shia13b26c2020-11-11 04:53:46 +08001758 (Contributed by Hai Shi and Petr Viktorin in :issue:`41073`.)
1759
Pablo Galindod439fb32021-02-20 18:03:08 +00001760* Add a new :c:func:`PySet_CheckExact` function to the C-API to check if an
1761 object is an instance of :class:`set` but not an instance of a subtype.
1762 (Contributed by Pablo Galindo in :issue:`43277`.)
Alex Gaynor3a8fdb22020-10-19 18:17:50 -04001763
Antoine Pitrouba251c22021-03-11 23:35:45 +01001764* Added :c:func:`PyErr_SetInterruptEx` which allows passing a signal number
1765 to simulate.
1766 (Contributed by Antoine Pitrou in :issue:`43356`.)
1767
Victor Stinnera41782c2021-04-08 22:32:21 +02001768* The limited C API is now supported if :ref:`Python is built in debug mode
1769 <debug-build>` (if the ``Py_DEBUG`` macro is defined). In the limited C API,
1770 the :c:func:`Py_INCREF` and :c:func:`Py_DECREF` functions are now implemented
1771 as opaque function
Victor Stinner3359cab2021-04-02 15:45:37 +02001772 calls, rather than accessing directly the :c:member:`PyObject.ob_refcnt`
1773 member, if Python is built in debug mode and the ``Py_LIMITED_API`` macro
1774 targets Python 3.10 or newer. It became possible to support the limited C API
1775 in debug mode because the :c:type:`PyObject` structure is the same in release
1776 and debug mode since Python 3.8 (see :issue:`36465`).
1777
Victor Stinner85918e42021-04-12 23:27:35 +02001778 The limited C API is still not supported in the :option:`--with-trace-refs`
1779 special build (``Py_TRACE_REFS`` macro).
Victor Stinner3359cab2021-04-02 15:45:37 +02001780 (Contributed by Victor Stinner in :issue:`43688`.)
Antoine Pitrouba251c22021-03-11 23:35:45 +01001781
Victor Stinner09bbebe2021-04-11 00:17:39 +02001782* Add the :c:func:`Py_Is(x, y) <Py_Is>` function to test if the *x* object is
1783 the *y* object, the same as ``x is y`` in Python. Add also the
1784 :c:func:`Py_IsNone`, :c:func:`Py_IsTrue`, :c:func:`Py_IsFalse` functions to
1785 test if an object is, respectively, the ``None`` singleton, the ``True``
1786 singleton or the ``False`` singleton.
1787 (Contributed by Victor Stinner in :issue:`43753`.)
1788
scoder3cc481b2021-04-28 18:12:16 +02001789* Add new functions to quickly control the garbage collector from C code:
1790 :c:func:`PyGC_Enable()`,
1791 :c:func:`PyGC_Disable()`,
1792 :c:func:`PyGC_IsEnabled()`.
1793 These functions allow to activate, deactivate and query the state of the garbage collector from C code without
1794 having to import the :mod:`gc` module.
1795
Victor Stinner3bb09942021-04-30 12:46:15 +02001796* Add a new :c:data:`Py_TPFLAGS_DISALLOW_INSTANTIATION` type flag to disallow
1797 creating type instances.
1798 (Contributed by Victor Stinner in :issue:`43916`.)
1799
Dong-hee Naad3252b2020-05-26 01:52:54 +09001800Porting to Python 3.10
1801----------------------
1802
Victor Stinner37bb2892020-06-19 11:45:31 +02001803* The ``PY_SSIZE_T_CLEAN`` macro must now be defined to use
1804 :c:func:`PyArg_ParseTuple` and :c:func:`Py_BuildValue` formats which use
1805 ``#``: ``es#``, ``et#``, ``s#``, ``u#``, ``y#``, ``z#``, ``U#`` and ``Z#``.
1806 See :ref:`Parsing arguments and building values
1807 <arg-parsing>` and the :pep:`353`.
1808 (Contributed by Victor Stinner in :issue:`40943`.)
1809
Victor Stinnerfe2978b2020-05-27 14:55:10 +02001810* Since :c:func:`Py_REFCNT()` is changed to the inline static function,
1811 ``Py_REFCNT(obj) = new_refcnt`` must be replaced with ``Py_SET_REFCNT(obj, new_refcnt)``:
Victor Stinnerdc24b8a2020-06-04 22:10:43 +02001812 see :c:func:`Py_SET_REFCNT()` (available since Python 3.9). For backward
1813 compatibility, this macro can be used::
1814
1815 #if PY_VERSION_HEX < 0x030900A4
1816 # define Py_SET_REFCNT(obj, refcnt) ((Py_REFCNT(obj) = (refcnt)), (void)0)
1817 #endif
1818
Victor Stinnerfe2978b2020-05-27 14:55:10 +02001819 (Contributed by Victor Stinner in :issue:`39573`.)
1820
Victor Stinner59d3dce2020-06-02 14:03:25 +02001821* Calling :c:func:`PyDict_GetItem` without :term:`GIL` held had been allowed
1822 for historical reason. It is no longer allowed.
1823 (Contributed by Victor Stinner in :issue:`40839`.)
1824
Inada Naoki038dd0f2020-06-30 15:26:56 +09001825* ``PyUnicode_FromUnicode(NULL, size)`` and ``PyUnicode_FromStringAndSize(NULL, size)``
1826 raise ``DeprecationWarning`` now. Use :c:func:`PyUnicode_New` to allocate
1827 Unicode object without initial data.
1828 (Contributed by Inada Naoki in :issue:`36346`.)
1829
Victor Stinner47e1afd2020-10-26 16:43:47 +01001830* The private ``_PyUnicode_Name_CAPI`` structure of the PyCapsule API
Victor Stinner84f73822020-10-27 04:36:22 +01001831 ``unicodedata.ucnhash_CAPI`` has been moved to the internal C API.
Victor Stinner920cb642020-10-26 19:19:36 +01001832 (Contributed by Victor Stinner in :issue:`42157`.)
Victor Stinner47e1afd2020-10-26 16:43:47 +01001833
Victor Stinnerace3f9a2020-11-10 21:10:22 +01001834* :c:func:`Py_GetPath`, :c:func:`Py_GetPrefix`, :c:func:`Py_GetExecPrefix`,
1835 :c:func:`Py_GetProgramFullPath`, :c:func:`Py_GetPythonHome` and
1836 :c:func:`Py_GetProgramName` functions now return ``NULL`` if called before
1837 :c:func:`Py_Initialize` (before Python is initialized). Use the new
1838 :ref:`Python Initialization Configuration API <init-config>` to get the
1839 :ref:`Python Path Configuration. <init-path-config>`.
1840 (Contributed by Victor Stinner in :issue:`42260`.)
1841
Victor Stinner0ef96c22020-12-07 11:56:20 +01001842* :c:func:`PyList_SET_ITEM`, :c:func:`PyTuple_SET_ITEM` and
1843 :c:func:`PyCell_SET` macros can no longer be used as l-value or r-value.
1844 For example, ``x = PyList_SET_ITEM(a, b, c)`` and
1845 ``PyList_SET_ITEM(a, b, c) = x`` now fail with a compiler error. It prevents
1846 bugs like ``if (PyList_SET_ITEM (a, b, c) < 0) ...`` test.
1847 (Contributed by Zackery Spytz and Victor Stinner in :issue:`30459`.)
1848
Nicholas Sim4a6bf272021-02-19 22:55:46 +08001849* The non-limited API files ``odictobject.h``, ``parser_interface.h``,
1850 ``picklebufobject.h``, ``pyarena.h``, ``pyctype.h``, ``pydebug.h``,
1851 ``pyfpe.h``, and ``pytime.h`` have been moved to the ``Include/cpython``
1852 directory. These files must not be included directly, as they are already
1853 included in ``Python.h``: :ref:`Include Files <api-includes>`. If they have
1854 been included directly, consider including ``Python.h`` instead.
1855 (Contributed by Nicholas Sim in :issue:`35134`)
1856
Victor Stinner583ee5a2020-10-02 14:49:00 +02001857Deprecated
1858----------
1859
1860* The ``PyUnicode_InternImmortal()`` function is now deprecated
1861 and will be removed in Python 3.12: use :c:func:`PyUnicode_InternInPlace`
1862 instead.
1863 (Contributed by Victor Stinner in :issue:`41692`.)
1864
Dong-hee Naad3252b2020-05-26 01:52:54 +09001865Removed
1866-------
Inada Naoki6f8a6ee2020-06-26 08:07:22 +09001867
1868* ``PyObject_AsCharBuffer()``, ``PyObject_AsReadBuffer()``, ``PyObject_CheckReadBuffer()``,
1869 and ``PyObject_AsWriteBuffer()`` are removed. Please migrate to new buffer protocol;
1870 :c:func:`PyObject_GetBuffer` and :c:func:`PyBuffer_Release`.
Inada Naoki20a79022020-06-27 18:22:09 +09001871 (Contributed by Inada Naoki in :issue:`41103`.)
1872
1873* Removed ``Py_UNICODE_str*`` functions manipulating ``Py_UNICODE*`` strings.
1874 (Contributed by Inada Naoki in :issue:`41123`.)
1875
1876 * ``Py_UNICODE_strlen``: use :c:func:`PyUnicode_GetLength` or
1877 :c:macro:`PyUnicode_GET_LENGTH`
1878 * ``Py_UNICODE_strcat``: use :c:func:`PyUnicode_CopyCharacters` or
1879 :c:func:`PyUnicode_FromFormat`
1880 * ``Py_UNICODE_strcpy``, ``Py_UNICODE_strncpy``: use
1881 :c:func:`PyUnicode_CopyCharacters` or :c:func:`PyUnicode_Substring`
1882 * ``Py_UNICODE_strcmp``: use :c:func:`PyUnicode_Compare`
1883 * ``Py_UNICODE_strncmp``: use :c:func:`PyUnicode_Tailmatch`
1884 * ``Py_UNICODE_strchr``, ``Py_UNICODE_strrchr``: use
1885 :c:func:`PyUnicode_FindChar`
Inada Naokid9f2a132020-06-29 10:46:51 +09001886
1887* Removed ``PyUnicode_GetMax()``. Please migrate to new (:pep:`393`) APIs.
1888 (Contributed by Inada Naoki in :issue:`41103`.)
Inada Naokie4f1fe62020-06-29 13:00:43 +09001889
1890* Removed ``PyLong_FromUnicode()``. Please migrate to :c:func:`PyLong_FromUnicodeObject`.
1891 (Contributed by Inada Naoki in :issue:`41103`.)
Inada Naokib3332662020-06-30 12:23:07 +09001892
1893* Removed ``PyUnicode_AsUnicodeCopy()``. Please use :c:func:`PyUnicode_AsUCS4Copy` or
1894 :c:func:`PyUnicode_AsWideCharString`
1895 (Contributed by Inada Naoki in :issue:`41103`.)
Victor Stinner19c3ac92020-09-23 14:04:57 +02001896
1897* Removed ``_Py_CheckRecursionLimit`` variable: it has been replaced by
1898 ``ceval.recursion_limit`` of the :c:type:`PyInterpreterState` structure.
1899 (Contributed by Victor Stinner in :issue:`41834`.)
Serhiy Storchakadcc54212020-10-05 12:32:00 +03001900
1901* Removed undocumented macros ``Py_ALLOW_RECURSION`` and
1902 ``Py_END_ALLOW_RECURSION`` and the ``recursion_critical`` field of the
1903 :c:type:`PyInterpreterState` structure.
1904 (Contributed by Serhiy Storchaka in :issue:`41936`.)
Victor Stinner296a7962020-11-17 16:22:23 +01001905
1906* Removed the undocumented ``PyOS_InitInterrupts()`` function. Initializing
1907 Python already implicitly installs signal handlers: see
1908 :c:member:`PyConfig.install_signal_handlers`.
1909 (Contributed by Victor Stinner in :issue:`41713`.)
Victor Stinnereec8e612021-03-18 14:57:49 +01001910
1911* Remove the ``PyAST_Validate()`` function. It is no longer possible to build a
1912 AST object (``mod_ty`` type) with the public C API. The function was already
1913 excluded from the limited C API (:pep:`384`).
1914 (Contributed by Victor Stinner in :issue:`43244`.)
Victor Stinner28ad12f2021-03-19 12:41:49 +01001915
1916* Remove the ``symtable.h`` header file and the undocumented functions:
1917
1918 * ``PyST_GetScope()``
1919 * ``PySymtable_Build()``
1920 * ``PySymtable_BuildObject()``
1921 * ``PySymtable_Free()``
1922 * ``Py_SymtableString()``
1923 * ``Py_SymtableStringObject()``
1924
1925 The ``Py_SymtableString()`` function was part the stable ABI by mistake but
1926 it could not be used, because the ``symtable.h`` header file was excluded
1927 from the limited C API.
1928
Victor Stinner94faa072021-03-23 20:47:40 +01001929 Use Python :mod:`symtable` module instead.
1930 (Contributed by Victor Stinner in :issue:`43244`.)
1931
Petr Viktorin91b69b72021-04-23 14:23:38 +02001932* Remove :c:func:`PyOS_ReadlineFunctionPointer` from the limited C API headers
1933 and from ``python3.dll``, the library that provides the stable ABI on
1934 Windows. Since the function takes a ``FILE*`` argument, its ABI stability
1935 cannot be guaranteed.
1936 (Contributed by Petr Viktorin in :issue:`43868`.)
1937
Victor Stinner94faa072021-03-23 20:47:40 +01001938* Remove ``ast.h``, ``asdl.h``, and ``Python-ast.h`` header files.
1939 These functions were undocumented and excluded from the limited C API.
1940 Most names defined by these header files were not prefixed by ``Py`` and so
1941 could create names conflicts. For example, ``Python-ast.h`` defined a
1942 ``Yield`` macro which was conflict with the ``Yield`` name used by the
1943 Windows ``<winbase.h>`` header. Use the Python :mod:`ast` module instead.
Victor Stinner28ad12f2021-03-19 12:41:49 +01001944 (Contributed by Victor Stinner in :issue:`43244`.)
Victor Stinnera81fca62021-03-24 00:51:50 +01001945
Victor Stinner57364ce2021-03-24 01:29:09 +01001946* Remove the compiler and parser functions using ``struct _mod`` type, because
1947 the public AST C API was removed:
Victor Stinnera81fca62021-03-24 00:51:50 +01001948
1949 * ``PyAST_Compile()``
1950 * ``PyAST_CompileEx()``
1951 * ``PyAST_CompileObject()``
1952 * ``PyFuture_FromAST()``
1953 * ``PyFuture_FromASTObject()``
Victor Stinner57364ce2021-03-24 01:29:09 +01001954 * ``PyParser_ASTFromFile()``
1955 * ``PyParser_ASTFromFileObject()``
1956 * ``PyParser_ASTFromFilename()``
1957 * ``PyParser_ASTFromString()``
1958 * ``PyParser_ASTFromStringObject()``
Victor Stinnera81fca62021-03-24 00:51:50 +01001959
1960 These functions were undocumented and excluded from the limited C API.
1961 (Contributed by Victor Stinner in :issue:`43244`.)
Victor Stinner8370e072021-03-24 02:23:01 +01001962
1963* Remove the ``pyarena.h`` header file with functions:
1964
1965 * ``PyArena_New()``
1966 * ``PyArena_Free()``
1967 * ``PyArena_Malloc()``
1968 * ``PyArena_AddPyObject()``
1969
1970 These functions were undocumented, excluded from the limited C API, and were
1971 only used internally by the compiler.
1972 (Contributed by Victor Stinner in :issue:`43244`.)