What's New In Python 3.10
Editor
Pablo Galindo Salgado
* Anyone can add text to this document. Do not spend very much time on the wording of your changes, because your text will probably get rewritten to some degree.
* The maintainer will go through Misc/NEWS periodically and add changes; it's therefore more important to add your changes to Misc/NEWS than to this file.
* This is not a complete list of every single change; completeness is the purpose of Misc/NEWS. Some changes I consider too small or esoteric to include. If such a change is added to the text, I'll just remove it. (This is another reason you shouldn't spend too much time on writing your addition.)
* If you want to draw your new text to the attention of the maintainer, add 'XXX' to the beginning of the paragraph or section.
* It's OK to just add a fragmentary note about a change. For example: "XXX Describe the transmogrify() function added to the socket module." The maintainer will research the change and write the necessary text.
* You can comment out your additions if you like, but it's not necessary (especially when a final release is some months away).
* Credit the author of a patch or bugfix. Just the name is sufficient; the e-mail address isn't necessary.
- It's helpful to add the bug/patch number as a comment:
XXX Describe the transmogrify() function added to the socket module. (Contributed by P.Y. Developer in
12345.)This saves the maintainer the effort of going through the git log when researching a change.
This article explains the new features in Python 3.10, compared to 3.9. Python 3.10 was released on October 4, 2021. For full details, see the changelog <changelog>.
Summary -- Release highlights
New syntax features:
634, Structural Pattern Matching: Specification635, Structural Pattern Matching: Motivation and Rationale636, Structural Pattern Matching: Tutorial12782, Parenthesized context managers are now officially allowed.
New features in the standard library:
618, Add Optional Length-Checking To zip.
Interpreter improvements:
626, Precise line numbers for debugging and other tools.
New typing features:
604, Allow writing union types as X | Y612, Parameter Specification Variables613, Explicit Type Aliases647, User-Defined Type Guards
Important deprecations, removals or restrictions:
644, Require OpenSSL 1.1.1 or newer632, Deprecate distutils module.623, Deprecate and prepare for the removal of the wstr member in PyUnicodeObject.624, Remove Py_UNICODE encoder APIs597, Add optional EncodingWarning
New Features
Parenthesized context managers
Using enclosing parentheses for continuation across multiple lines in context managers is now supported. This allows formatting a long collection of context managers in multiple lines in a similar way as it was previously possible with import statements. For instance, all these examples are now valid:
with (CtxManager() as example):
...
with (
CtxManager1(),
CtxManager2()
):
...
with (CtxManager1() as example,
CtxManager2()):
...
with (CtxManager1(),
CtxManager2() as example):
...
with (
CtxManager1() as example1,
CtxManager2() as example2
):
...
it is also possible to use a trailing comma at the end of the enclosed group:
with (
CtxManager1() as example1,
CtxManager2() as example2,
CtxManager3() as example3,
):
...
This new syntax uses the non LL(1) capacities of the new parser. Check 617 for more details.
(Contributed by Guido van Rossum, Pablo Galindo and Lysandros Nikolaou in 12782 and 40334.)
Better error messages
SyntaxErrors
When parsing code that contains unclosed parentheses or brackets the interpreter now includes the location of the unclosed bracket of parentheses instead of displaying SyntaxError: unexpected EOF while parsing or pointing to some incorrect location. For instance, consider the following code (notice the unclosed '{'):
expected = {9: 1, 18: 2, 19: 2, 27: 3, 28: 3, 29: 3, 36: 4, 37: 4,
38: 4, 39: 4, 45: 5, 46: 5, 47: 5, 48: 5, 49: 5, 54: 6,
some_other_code = foo()
Previous versions of the interpreter reported confusing places as the location of the syntax error:
File "example.py", line 3
some_other_code = foo()
^
SyntaxError: invalid syntax
but in Python 3.10 a more informative error is emitted:
File "example.py", line 1
expected = {9: 1, 18: 2, 19: 2, 27: 3, 28: 3, 29: 3, 36: 4, 37: 4,
^
SyntaxError: '{' was never closed
In a similar way, errors involving unclosed string literals (single and triple quoted) now point to the start of the string instead of reporting EOF/EOL.
These improvements are inspired by previous work in the PyPy interpreter.
(Contributed by Pablo Galindo in 42864 and Batuhan Taskaya in 40176.)
SyntaxError exceptions raised by the interpreter will now highlight the full error range of the expression that constitutes the syntax error itself, instead of just where the problem is detected. In this way, instead of displaying (before Python 3.10):
>>> foo(x, z for z in range(10), t, w)
File "<stdin>", line 1
foo(x, z for z in range(10), t, w)
^
SyntaxError: Generator expression must be parenthesized
now Python 3.10 will display the exception as:
>>> foo(x, z for z in range(10), t, w)
File "<stdin>", line 1
foo(x, z for z in range(10), t, w)
^^^^^^^^^^^^^^^^^^^^
SyntaxError: Generator expression must be parenthesized
This improvement was contributed by Pablo Galindo in 43914.
A considerable amount of new specialized messages for SyntaxError exceptions have been incorporated. Some of the most notable ones are as follows:
-
Missing
:before blocks:>>> if rocket.position > event_horizon File "<stdin>", line 1 if rocket.position > event_horizon ^ SyntaxError: expected ':'(Contributed by Pablo Galindo in
42997.) -
Unparenthesised tuples in comprehensions targets:
>>> {x,y for x,y in zip('abcd', '1234')} File "<stdin>", line 1 {x,y for x,y in zip('abcd', '1234')} ^ SyntaxError: did you forget parentheses around the comprehension target?(Contributed by Pablo Galindo in
43017.) -
Missing commas in collection literals and between expressions:
>>> items = { ... x: 1, ... y: 2 ... z: 3, File "<stdin>", line 3 y: 2 ^ SyntaxError: invalid syntax. Perhaps you forgot a comma?(Contributed by Pablo Galindo in
43822.) -
Multiple Exception types without parentheses:
>>> try: ... build_dyson_sphere() ... except NotEnoughScienceError, NotEnoughResourcesError: File "<stdin>", line 3 except NotEnoughScienceError, NotEnoughResourcesError: ^ SyntaxError: multiple exception types must be parenthesized(Contributed by Pablo Galindo in
43149.) -
Missing
:and values in dictionary literals:>>> values = { ... x: 1, ... y: 2, ... z: ... } File "<stdin>", line 4 z: ^ SyntaxError: expression expected after dictionary key and ':' >>> values = {x:1, y:2, z w:3} File "<stdin>", line 1 values = {x:1, y:2, z w:3} ^ SyntaxError: ':' expected after dictionary key(Contributed by Pablo Galindo in
43823.) -
tryblocks withoutexceptorfinallyblocks:>>> try: ... x = 2 ... something = 3 File "<stdin>", line 3 something = 3 ^^^^^^^^^ SyntaxError: expected 'except' or 'finally' block(Contributed by Pablo Galindo in
44305.) -
Usage of
=instead of==in comparisons:>>> if rocket.position = event_horizon: File "<stdin>", line 1 if rocket.position = event_horizon: ^ SyntaxError: cannot assign to attribute here. Maybe you meant '==' instead of '='?(Contributed by Pablo Galindo in
43797.) -
Usage of
*in f-strings:>>> f"Black holes {*all_black_holes} and revelations" File "<stdin>", line 1 (*all_black_holes) ^ SyntaxError: f-string: cannot use starred expression here(Contributed by Pablo Galindo in
41064.)
IndentationErrors
Many IndentationError exceptions now have more context regarding what kind of block was expecting an indentation, including the location of the statement:
>>> def foo():
... if lel:
... x = 2
File "<stdin>", line 3
x = 2
^
IndentationError: expected an indented block after 'if' statement in line 2
AttributeErrors
When printing AttributeError, !PyErr_Display will offer suggestions of similar attribute names in the object that the exception was raised from:
>>> collections.namedtoplo
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: module 'collections' has no attribute 'namedtoplo'. Did you mean: namedtuple?
(Contributed by Pablo Galindo in 38530.)
[!WARNING] Notice this won't work if
!PyErr_Displayis not called to display the error which can happen if some other custom error display function is used. This is a common scenario in some REPLs like IPython.
NameErrors
When printing NameError raised by the interpreter, !PyErr_Display will offer suggestions of similar variable names in the function that the exception was raised from:
>>> schwarzschild_black_hole = None
>>> schwarschild_black_hole
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
NameError: name 'schwarschild_black_hole' is not defined. Did you mean: schwarzschild_black_hole?
(Contributed by Pablo Galindo in 38530.)
[!WARNING] Notice this won't work if
!PyErr_Displayis not called to display the error, which can happen if some other custom error display function is used. This is a common scenario in some REPLs like IPython.
PEP 626: Precise line numbers for debugging and other tools
PEP 626 brings more precise and reliable line numbers for debugging, profiling and coverage tools. Tracing events, with the correct line number, are generated for all lines of code executed and only for lines of code that are executed.
The ~frame.f_lineno attribute of frame objects will always contain the expected line number.
The !codeobject.co_lnotab attribute of code objects <code-objects> is deprecated and will be removed in 3.12. Code that needs to convert from offset to line number should use the new ~codeobject.co_lines method instead.
PEP 634: Structural Pattern Matching
Structural pattern matching has been added in the form of a match statement and case statements of patterns with associated actions. Patterns consist of sequences, mappings, primitive data types as well as class instances. Pattern matching enables programs to extract information from complex data types, branch on the structure of data, and apply specific actions based on different forms of data.
Syntax and operations
The generic syntax of pattern matching is:
match subject:
case <pattern_1>:
<action_1>
case <pattern_2>:
<action_2>
case <pattern_3>:
<action_3>
case _:
<action_wildcard>
A match statement takes an expression and compares its value to successive patterns given as one or more case blocks. Specifically, pattern matching operates by:
- using data with type and shape (the
subject) - evaluating the
subjectin thematchstatement - comparing the subject with each pattern in a
casestatement from top to bottom until a match is confirmed. - executing the action associated with the pattern of the confirmed match
- If an exact match is not confirmed, the last case, a wildcard
_, if provided, will be used as the matching case. If an exact match is not confirmed and a wildcard case does not exist, the entire match block is a no-op.
Declarative approach
Readers may be aware of pattern matching through the simple example of matching a subject (data object) to a literal (pattern) with the switch statement found in C, Java or JavaScript (and many other languages). Often the switch statement is used for comparison of an object/expression with case statements containing literals.
More powerful examples of pattern matching can be found in languages such as Scala and Elixir. With structural pattern matching, the approach is "declarative" and explicitly states the conditions (the patterns) for data to match.
While an "imperative" series of instructions using nested "if" statements could be used to accomplish something similar to structural pattern matching, it is less clear than the "declarative" approach. Instead the "declarative" approach states the conditions to meet for a match and is more readable through its explicit patterns. While structural pattern matching can be used in its simplest form comparing a variable to a literal in a case statement, its true value for Python lies in its handling of the subject's type and shape.
Simple pattern: match to a literal
Let's look at this example as pattern matching in its simplest form: a value, the subject, being matched to several literals, the patterns. In the example below, status is the subject of the match statement. The patterns are each of the case statements, where literals represent request status codes. The associated action to the case is executed after a match:
def http_error(status):
match status:
case 400:
return "Bad request"
case 404:
return "Not found"
case 418:
return "I'm a teapot"
case _:
return "Something's wrong with the internet"
If the above function is passed a status of 418, "I'm a teapot" is returned. If the above function is passed a status of 500, the case statement with _ will match as a wildcard, and "Something's wrong with the internet" is returned. Note the last block: the variable name, _, acts as a wildcard and insures the subject will always match. The use of _ is optional.
You can combine several literals in a single pattern using | ("or"):
case 401 | 403 | 404:
return "Not allowed"
Behavior without the wildcard
If we modify the above example by removing the last case block, the example becomes:
def http_error(status):
match status:
case 400:
return "Bad request"
case 404:
return "Not found"
case 418:
return "I'm a teapot"
Without the use of _ in a case statement, a match may not exist. If no match exists, the behavior is a no-op. For example, if status of 500 is passed, a no-op occurs.
Patterns with a literal and variable
Patterns can look like unpacking assignments, and a pattern may be used to bind variables. In this example, a data point can be unpacked to its x-coordinate and y-coordinate:
# point is an (x, y) tuple
match point:
case (0, 0):
print("Origin")
case (0, y):
print(f"Y={y}")
case (x, 0):
print(f"X={x}")
case (x, y):
print(f"X={x}, Y={y}")
case _:
raise ValueError("Not a point")
The first pattern has two literals, (0, 0), and may be thought of as an extension of the literal pattern shown above. The next two patterns combine a literal and a variable, and the variable binds a value from the subject (point). The fourth pattern captures two values, which makes it conceptually similar to the unpacking assignment (x, y) = point.
Patterns and classes
If you are using classes to structure your data, you can use as a pattern the class name followed by an argument list resembling a constructor. This pattern has the ability to capture instance attributes into variables:
class Point:
def __init__(self, x, y):
self.x = x
self.y = y
def location(point):
match point:
case Point(x=0, y=0):
print("Origin is the point's location.")
case Point(x=0, y=y):
print(f"Y={y} and the point is on the y-axis.")
case Point(x=x, y=0):
print(f"X={x} and the point is on the x-axis.")
case Point():
print("The point is located somewhere else on the plane.")
case _:
print("Not a point")
Patterns with positional parameters
You can use positional parameters with some builtin classes that provide an ordering for their attributes (e.g. dataclasses). You can also define a specific position for attributes in patterns by setting the __match_args__ special attribute in your classes. If it's set to ("x", "y"), the following patterns are all equivalent (and all bind the y attribute to the var variable):
Point(1, var)
Point(1, y=var)
Point(x=1, y=var)
Point(y=var, x=1)
Nested patterns
Patterns can be arbitrarily nested. For example, if our data is a short list of points, it could be matched like this:
match points:
case []:
print("No points in the list.")
case [Point(0, 0)]:
print("The origin is the only point in the list.")
case [Point(x, y)]:
print(f"A single point {x}, {y} is in the list.")
case [Point(0, y1), Point(0, y2)]:
print(f"Two points on the Y axis at {y1}, {y2} are in the list.")
case _:
print("Something else is found in the list.")
Complex patterns and the wildcard
To this point, the examples have used _ alone in the last case statement. A wildcard can be used in more complex patterns, such as ('error', code, _). For example:
match test_variable:
case ('warning', code, 40):
print("A warning has been received.")
case ('error', code, _):
print(f"An error {code} occurred.")
In the above case, test_variable will match for ('error', code, 100) and ('error', code, 800).
Guard
We can add an if clause to a pattern, known as a "guard". If the guard is false, match goes on to try the next case block. Note that value capture happens before the guard is evaluated:
match point:
case Point(x, y) if x == y:
print(f"The point is located on the diagonal Y=X at {x}.")
case Point(x, y):
print(f"Point is not on the diagonal.")
Other Key Features
Several other key features:
-
Like unpacking assignments, tuple and list patterns have exactly the same meaning and actually match arbitrary sequences. Technically, the subject must be a sequence. Therefore, an important exception is that patterns don't match iterators. Also, to prevent a common mistake, sequence patterns don't match strings.
-
Sequence patterns support wildcards:
[x, y, *rest]and(x, y, *rest)work similar to wildcards in unpacking assignments. The name after*may also be_, so(x, y, *_)matches a sequence of at least two items without binding the remaining items. -
Mapping patterns:
{"bandwidth": b, "latency": l}captures the"bandwidth"and"latency"values from a dict. Unlike sequence patterns, extra keys are ignored. A wildcard**restis also supported. (But**_would be redundant, so is not allowed.) -
Subpatterns may be captured using the
askeyword:case (Point(x1, y1), Point(x2, y2) as p2): ...This binds x1, y1, x2, y2 like you would expect without the
asclause, and p2 to the entire second item of the subject. -
Most literals are compared by equality. However, the singletons
True,FalseandNoneare compared by identity. -
Named constants may be used in patterns. These named constants must be dotted names to prevent the constant from being interpreted as a capture variable:
from enum import Enum class Color(Enum): RED = 0 GREEN = 1 BLUE = 2 color = Color.GREEN match color: case Color.RED: print("I see red!") case Color.GREEN: print("Grass is green") case Color.BLUE: print("I'm feeling the blues :(")
For the full specification see 634. Motivation and rationale are in 635, and a longer tutorial is in 636.
Optional EncodingWarning and encoding="locale" option
The default encoding of ~io.TextIOWrapper and open is platform and locale dependent. Since UTF-8 is used on most Unix platforms, omitting encoding option when opening UTF-8 files (e.g. JSON, YAML, TOML, Markdown) is a very common bug. For example:
# BUG: "rb" mode or encoding="utf-8" should be used.
with open("data.json") as f:
data = json.load(f)
To find this type of bug, an optional EncodingWarning is added. It is emitted when sys.flags.warn_default_encoding <sys.flags> is true and locale-specific default encoding is used.
-X warn_default_encoding option and PYTHONWARNDEFAULTENCODING are added to enable the warning.
See io-text-encoding for more information.
New Features Related to Type Hints
This section covers major changes affecting 484 type hints and the typing module.
PEP 604: New Type Union Operator
A new type union operator was introduced which enables the syntax X | Y. This provides a cleaner way of expressing 'either type X or type Y' instead of using typing.Union, especially in type hints.
In previous versions of Python, to apply a type hint for functions accepting arguments of multiple types, typing.Union was used:
def square(number: Union[int, float]) -> Union[int, float]:
return number ** 2
Type hints can now be written in a more succinct manner:
def square(number: int | float) -> int | float:
return number ** 2
This new syntax is also accepted as the second argument to isinstance and issubclass:
>>> isinstance(1, int | str)
True
See types-union and 604 for more details.
(Contributed by Maggie Moss and Philippe Prados in 41428, with additions by Yurii Karabas and Serhiy Storchaka in 44490.)
PEP 612: Parameter Specification Variables
Two new options to improve the information provided to static type checkers for 484's Callable have been added to the typing module.
The first is the parameter specification variable. They are used to forward the parameter types of one callable to another callable -- a pattern commonly found in higher order functions and decorators. Examples of usage can be found in typing.ParamSpec. Previously, there was no easy way to type annotate dependency of parameter types in such a precise manner.
The second option is the new Concatenate operator. It's used in conjunction with parameter specification variables to type annotate a higher order callable which adds or removes parameters of another callable. Examples of usage can be found in typing.Concatenate.
See typing.Callable, typing.ParamSpec, typing.Concatenate, typing.ParamSpecArgs, typing.ParamSpecKwargs, and 612 for more details.
(Contributed by Ken Jin in 41559, with minor enhancements by Jelle Zijlstra in 43783. PEP written by Mark Mendoza.)
PEP 613: TypeAlias
484 introduced the concept of type aliases, only requiring them to be top-level unannotated assignments. This simplicity sometimes made it difficult for type checkers to distinguish between type aliases and ordinary assignments, especially when forward references or invalid types were involved. Compare:
StrCache = 'Cache[str]' # a type alias
LOG_PREFIX = 'LOG[DEBUG]' # a module constant
Now the typing module has a special value ~typing.TypeAlias which lets you declare type aliases more explicitly:
StrCache: TypeAlias = 'Cache[str]' # a type alias
LOG_PREFIX = 'LOG[DEBUG]' # a module constant
See 613 for more details.
(Contributed by Mikhail Golubev in 41923.)
PEP 647: User-Defined Type Guards
~typing.TypeGuard has been added to the typing module to annotate type guard functions and improve information provided to static type checkers during type narrowing. For more information, please see ~typing.TypeGuard's documentation, and 647.
(Contributed by Ken Jin and Guido van Rossum in 43766. PEP written by Eric Traut.)
Other Language Changes
- The
inttype has a new methodint.bit_count, returning the number of ones in the binary expansion of a given integer, also known as the population count. (Contributed by Niklas Fiekas in29882.) - The views returned by
dict.keys,dict.valuesanddict.itemsnow all have amappingattribute that gives atypes.MappingProxyTypeobject wrapping the original dictionary. (Contributed by Dennis Sweeney in40890.) 618: Thezipfunction now has an optionalstrictflag, used to require that all the iterables have an equal length.- Builtin and extension functions that take integer arguments no longer accept
~decimal.Decimals,~fractions.Fractions and other objects that can be converted to integers only with a loss (e.g. that have the~object.__int__method but do not have the~object.__index__method). (Contributed by Serhiy Storchaka in37999.) - If
object.__ipow__returnsNotImplemented, the operator will correctly fall back toobject.__pow__andobject.__rpow__as expected. (Contributed by Alex Shkop in38302.) - Assignment expressions can now be used unparenthesized within set literals and set comprehensions, as well as in sequence indexes (but not slices).
- Functions have a new
__builtins__attribute which is used to look for builtin symbols when a function is executed, instead of looking into__globals__['__builtins__']. The attribute is initialized from__globals__["__builtins__"]if it exists, else from the current builtins. (Contributed by Mark Shannon in42990.) - Two new builtin functions --
aiterandanexthave been added to provide asynchronous counterparts toiterandnext, respectively. (Contributed by Joshua Bronson, Daniel Pope, and Justin Wang in31861.) - Static methods (
staticmethod) and class methods (classmethod) now inherit the method attributes (__module__,__name__,__qualname__,__doc__,__annotations__) and have a new__wrapped__attribute. Moreover, static methods are now callable as regular functions. (Contributed by Victor Stinner in43682.) - Annotations for complex targets (everything beside
simple nametargets defined by526) no longer cause any runtime effects withfrom __future__ import annotations. (Contributed by Batuhan Taskaya in42737.) - Class and module objects now lazy-create empty annotations dicts on demand. The annotations dicts are stored in the object’s
__dict__for backwards compatibility. This improves the best practices for working with__annotations__; for more information, please seeannotations-howto. (Contributed by Larry Hastings in43901.) - Annotations consist of
yield,yield from,awaitor named expressions are now forbidden underfrom __future__ import annotationsdue to their side effects. (Contributed by Batuhan Taskaya in42725.) - Usage of unbound variables,
super()and other expressions that might alter the processing of symbol table as annotations are now rendered effectless underfrom __future__ import annotations. (Contributed by Batuhan Taskaya in42725.) - Hashes of NaN values of both
floattype anddecimal.Decimaltype now depend on object identity. Formerly, they always hashed to0even though NaN values are not equal to one another. This caused potentially quadratic runtime behavior due to excessive hash collisions when creating dictionaries and sets containing multiple NaNs. (Contributed by Raymond Hettinger in43475.) - A
SyntaxError(instead of aNameError) will be raised when deleting the__debug__constant. (Contributed by Donghee Na in45000.) SyntaxErrorexceptions now haveend_linenoandend_offsetattributes. They will beNoneif not determined. (Contributed by Pablo Galindo in43914.)
New Modules
- None.
Improved Modules
asyncio
Add missing ~asyncio.loop.connect_accepted_socket method. (Contributed by Alex Grönholm in 41332.)
argparse
Misleading phrase "optional arguments" was replaced with "options" in argparse help. Some tests might require adaptation if they rely on exact output match. (Contributed by Raymond Hettinger in 9694.)
array
The ~array.array.index method of array.array now has optional start and stop parameters. (Contributed by Anders Lorentsen and Zackery Spytz in 31956.)
asynchat, asyncore, smtpd
These modules have been marked as deprecated in their module documentation since Python 3.6. An import-time DeprecationWarning has now been added to all three of these modules.
base64
Add base64.b32hexencode and base64.b32hexdecode to support the Base32 Encoding with Extended Hex Alphabet.
bdb
Add !clearBreakpoints to reset all set breakpoints. (Contributed by Irit Katriel in 24160.)
bisect
Added the possibility of providing a key function to the APIs in the bisect module. (Contributed by Raymond Hettinger in 4356.)
codecs
Add a codecs.unregister function to unregister a codec search function. (Contributed by Hai Shi in 41842.)
collections.abc
The __args__ of the parameterized generic <types-genericalias> for collections.abc.Callable are now consistent with typing.Callable. collections.abc.Callable generic now flattens type parameters, similar to what typing.Callable currently does. This means that collections.abc.Callable[[int, str], str] will have __args__ of (int, str, str); previously this was ([int, str], str). To allow this change, types.GenericAlias can now be subclassed, and a subclass will be returned when subscripting the collections.abc.Callable type. Note that a TypeError may be raised for invalid forms of parameterizing collections.abc.Callable which may have passed silently in Python 3.9. (Contributed by Ken Jin in 42195.)
contextlib
Add a contextlib.aclosing context manager to safely close async generators and objects representing asynchronously released resources. (Contributed by Joongi Kim and John Belmonte in 41229.)
Add asynchronous context manager support to contextlib.nullcontext. (Contributed by Tom Gringauz in 41543.)
Add ~contextlib.AsyncContextDecorator, for supporting usage of async context managers as decorators.
curses
The extended color functions added in ncurses 6.1 will be used transparently by curses.color_content, curses.init_color, curses.init_pair, and curses.pair_content. A new function, curses.has_extended_color_support, indicates whether extended color support is provided by the underlying ncurses library. (Contributed by Jeffrey Kintscher and Hans Petter Jansson in 36982.)
dataclasses
__slots__
Added slots parameter in dataclasses.dataclass decorator. (Contributed by Yurii Karabas in 42269)
Keyword-only fields
dataclasses now supports fields that are keyword-only in the generated __init__ method. There are a number of ways of specifying keyword-only fields.
You can say that every field is keyword-only:
from dataclasses import dataclass
@dataclass(kw_only=True)
class Birthday:
name: str
birthday: datetime.date
Both name and birthday are keyword-only parameters to the generated __init__ method.
You can specify keyword-only on a per-field basis:
from dataclasses import dataclass, field
@dataclass
class Birthday:
name: str
birthday: datetime.date = field(kw_only=True)
Here only birthday is keyword-only. If you set kw_only on individual fields, be aware that there are rules about re-ordering fields due to keyword-only fields needing to follow non-keyword-only fields. See the full dataclasses documentation for details.
You can also specify that all fields following a KW_ONLY marker are keyword-only. This will probably be the most common usage:
from dataclasses import dataclass, KW_ONLY
@dataclass
class Point:
x: float
y: float
_: KW_ONLY
z: float = 0.0
t: float = 0.0
Here, z and t are keyword-only parameters, while x and y are not. (Contributed by Eric V. Smith in 43532.)
distutils
The entire distutils package is deprecated, to be removed in Python 3.12. Its functionality for specifying package builds has already been completely replaced by third-party packages setuptools and packaging, and most other commonly used APIs are available elsewhere in the standard library (such as platform, shutil, subprocess or sysconfig). There are no plans to migrate any other functionality from distutils, and applications that are using other functions should plan to make private copies of the code. Refer to 632 for discussion.
The bdist_wininst command deprecated in Python 3.8 has been removed. The bdist_wheel command is now recommended to distribute binary packages on Windows. (Contributed by Victor Stinner in 42802.)
doctest
When a module does not define __loader__, fall back to __spec__.loader. (Contributed by Brett Cannon in 42133.)
encodings
encodings.normalize_encoding now ignores non-ASCII characters. (Contributed by Hai Shi in 39337.)
enum
~enum.Enum ~object.__repr__ now returns enum_name.member_name and ~object.__str__ now returns member_name. Stdlib enums available as module constants have a repr of module_name.member_name. (Contributed by Ethan Furman in 40066.)
Add enum.StrEnum for enums where all members are strings. (Contributed by Ethan Furman in 41816.)
fileinput
Add encoding and errors parameters in fileinput.input and fileinput.FileInput. (Contributed by Inada Naoki in 43712.)
fileinput.hook_compressed now returns ~io.TextIOWrapper object when mode is "r" and file is compressed, like uncompressed files. (Contributed by Inada Naoki in 5758.)
faulthandler
The faulthandler module now detects if a fatal error occurs during a garbage collector collection. (Contributed by Victor Stinner in 44466.)
gc
Add audit hooks for gc.get_objects, gc.get_referrers and gc.get_referents. (Contributed by Pablo Galindo in 43439.)
glob
Add the root_dir and dir_fd parameters in ~glob.glob and ~glob.iglob which allow to specify the root directory for searching. (Contributed by Serhiy Storchaka in 38144.)
hashlib
The hashlib module requires OpenSSL 1.1.1 or newer. (Contributed by Christian Heimes in 644 and 43669.)
The hashlib module has preliminary support for OpenSSL 3.0.0. (Contributed by Christian Heimes in 38820 and other issues.)
The pure-Python fallback of ~hashlib.pbkdf2_hmac is deprecated. In the future PBKDF2-HMAC will only be available when Python has been built with OpenSSL support. (Contributed by Christian Heimes in 43880.)
hmac
The hmac module now uses OpenSSL's HMAC implementation internally. (Contributed by Christian Heimes in 40645.)
IDLE and idlelib
Make IDLE invoke sys.excepthook (when started without '-n'). User hooks were previously ignored. (Contributed by Ken Hilton in 43008.)
Rearrange the settings dialog. Split the General tab into Windows and Shell/Ed tabs. Move help sources, which extend the Help menu, to the Extensions tab. Make space for new options and shorten the dialog. The latter makes the dialog better fit small screens. (Contributed by Terry Jan Reedy in 40468.) Move the indent space setting from the Font tab to the new Windows tab. (Contributed by Mark Roseman and Terry Jan Reedy in 33962.)
The changes above were backported to a 3.9 maintenance release.
Use spaces instead of tabs to indent interactive code. This makes interactive code entries 'look right'. Making this feasible was a major motivation for adding the shell sidebar. (Contributed by Terry Jan Reedy in 37892.)
Highlight the new soft keywords <soft-keywords> match, case <match>, and _ <wildcard-patterns> in pattern-matching statements. However, this highlighting is not perfect and will be incorrect in some rare cases, including some _-s in case patterns. (Contributed by Tal Einat in 44010.)
New in 3.10 maintenance releases.
Apply syntax highlighting to .pyi files. (Contributed by Alex Waygood and Terry Jan Reedy in 45447.)
Include prompts when saving Shell with inputs and outputs. (Contributed by Terry Jan Reedy in 95191.)
importlib.metadata
Feature parity with importlib_metadata 4.6 (history).
importlib.metadata entry points <entry-points> now provide a nicer experience for selecting entry points by group and name through a new importlib.metadata.EntryPoints <entry-points> class. See the Compatibility Note in the docs for more info on the deprecation and usage.
Added importlib.metadata.packages_distributions() <package-distributions> for resolving top-level Python modules and packages to their importlib.metadata.Distribution <distributions>.
inspect
When a module does not define __loader__, fall back to __spec__.loader. (Contributed by Brett Cannon in 42133.)
Add inspect.get_annotations, which safely computes the annotations defined on an object. It works around the quirks of accessing the annotations on various types of objects, and makes very few assumptions about the object it examines. inspect.get_annotations can also correctly un-stringize stringized annotations. inspect.get_annotations is now considered best practice for accessing the annotations dict defined on any Python object; for more information on best practices for working with annotations, please see annotations-howto. Relatedly, inspect.signature, inspect.Signature.from_callable, and !inspect.Signature.from_function now call inspect.get_annotations to retrieve annotations. This means inspect.signature and inspect.Signature.from_callable can also now un-stringize stringized annotations. (Contributed by Larry Hastings in 43817.)
itertools
Add itertools.pairwise. (Contributed by Raymond Hettinger in 38200.)
linecache
When a module does not define __loader__, fall back to __spec__.loader. (Contributed by Brett Cannon in 42133.)
os
Add os.cpu_count support for VxWorks RTOS. (Contributed by Peixing Xin in 41440.)
Add a new function os.eventfd and related helpers to wrap the eventfd2 syscall on Linux. (Contributed by Christian Heimes in 41001.)
Add os.splice that allows to move data between two file descriptors without copying between kernel address space and user address space, where one of the file descriptors must refer to a pipe. (Contributed by Pablo Galindo in 41625.)
Add ~os.O_EVTONLY, ~os.O_FSYNC, ~os.O_SYMLINK and ~os.O_NOFOLLOW_ANY for macOS. (Contributed by Donghee Na in 43106.)
os.path
os.path.realpath now accepts a strict keyword-only argument. When set to True, OSError is raised if a path doesn't exist or a symlink loop is encountered. (Contributed by Barney Gale in 43757.)
pathlib
Add slice support to PurePath.parents <pathlib.PurePath.parents>. (Contributed by Joshua Cannon in 35498.)
Add negative indexing support to PurePath.parents <pathlib.PurePath.parents>. (Contributed by Yaroslav Pankovych in 21041.)
Add Path.hardlink_to <pathlib.Path.hardlink_to> method that supersedes !link_to. The new method has the same argument order as ~pathlib.Path.symlink_to. (Contributed by Barney Gale in 39950.)
pathlib.Path.stat and ~pathlib.Path.chmod now accept a follow_symlinks keyword-only argument for consistency with corresponding functions in the os module. (Contributed by Barney Gale in 39906.)
platform
Add platform.freedesktop_os_release to retrieve operation system identification from freedesktop.org os-release standard file. (Contributed by Christian Heimes in 28468.)
pprint
pprint.pprint now accepts a new underscore_numbers keyword argument. (Contributed by sblondon in 42914.)
pprint can now pretty-print dataclasses.dataclass instances. (Contributed by Lewis Gaul in 43080.)
py_compile
Add --quiet option to command-line interface of py_compile. (Contributed by Gregory Schevchenko in 38731.)
pyclbr
Add an end_lineno attribute to the Function and Class objects in the tree returned by pyclbr.readmodule and pyclbr.readmodule_ex. It matches the existing (start) lineno. (Contributed by Aviral Srivastava in 38307.)
shelve
The shelve module now uses pickle.DEFAULT_PROTOCOL by default instead of pickle protocol 3 when creating shelves. (Contributed by Zackery Spytz in 34204.)
statistics
Add ~statistics.covariance, Pearson's ~statistics.correlation, and simple ~statistics.linear_regression functions. (Contributed by Tymoteusz Wołodźko in 38490.)
site
When a module does not define __loader__, fall back to __spec__.loader. (Contributed by Brett Cannon in 42133.)
socket
The exception socket.timeout is now an alias of TimeoutError. (Contributed by Christian Heimes in 42413.)
Add option to create MPTCP sockets with IPPROTO_MPTCP (Contributed by Rui Cunha in 43571.)
Add IP_RECVTOS option to receive the type of service (ToS) or DSCP/ECN fields (Contributed by Georg Sauthoff in 44077.)
ssl
The ssl module requires OpenSSL 1.1.1 or newer. (Contributed by Christian Heimes in 644 and 43669.)
The ssl module has preliminary support for OpenSSL 3.0.0 and new option ~ssl.OP_IGNORE_UNEXPECTED_EOF. (Contributed by Christian Heimes in 38820, 43794, 43788, 43791, 43799, 43920, 43789, and 43811.)
Deprecated function and use of deprecated constants now result in a DeprecationWarning. ssl.SSLContext.options has ~ssl.OP_NO_SSLv2 and ~ssl.OP_NO_SSLv3 set by default and therefore cannot warn about setting the flag again. The deprecation section <whatsnew310-deprecated> has a list of deprecated features. (Contributed by Christian Heimes in 43880.)
The ssl module now has more secure default settings. Ciphers without forward secrecy or SHA-1 MAC are disabled by default. Security level 2 prohibits weak RSA, DH, and ECC keys with less than 112 bits of security. ~ssl.SSLContext defaults to minimum protocol version TLS 1.2. Settings are based on Hynek Schlawack's research. (Contributed by Christian Heimes in 43998.)
The deprecated protocols SSL 3.0, TLS 1.0, and TLS 1.1 are no longer officially supported. Python does not block them actively. However OpenSSL build options, distro configurations, vendor patches, and cipher suites may prevent a successful handshake.
Add a timeout parameter to the ssl.get_server_certificate function. (Contributed by Zackery Spytz in 31870.)
The ssl module uses heap-types and multi-phase initialization. (Contributed by Christian Heimes in 42333.)
A new verify flag ~ssl.VERIFY_X509_PARTIAL_CHAIN has been added. (Contributed by l0x in 40849.)
sqlite3
Add audit events for ~sqlite3.connect, ~sqlite3.Connection.enable_load_extension, and ~sqlite3.Connection.load_extension. (Contributed by Erlend E. Aasland in 43762.)
sys
Add sys.orig_argv attribute: the list of the original command line arguments passed to the Python executable. (Contributed by Victor Stinner in 23427.)
Add sys.stdlib_module_names, containing the list of the standard library module names. (Contributed by Victor Stinner in 42955.)
thread
_thread.interrupt_main now takes an optional signal number to simulate (the default is still signal.SIGINT). (Contributed by Antoine Pitrou in 43356.)
threading
Add threading.gettrace and threading.getprofile to retrieve the functions set by threading.settrace and threading.setprofile respectively. (Contributed by Mario Corchero in 42251.)
Add threading.__excepthook__ to allow retrieving the original value of threading.excepthook in case it is set to a broken or a different value. (Contributed by Mario Corchero in 42308.)
traceback
The ~traceback.format_exception, ~traceback.format_exception_only, and ~traceback.print_exception functions can now take an exception object as a positional-only argument. (Contributed by Zackery Spytz and Matthias Bussonnier in 26389.)
types
Reintroduce the types.EllipsisType, types.NoneType and types.NotImplementedType classes, providing a new set of types readily interpretable by type checkers. (Contributed by Bas van Beek in 41810.)
typing
For major changes, see new-feat-related-type-hints.
The behavior of typing.Literal was changed to conform with 586 and to match the behavior of static type checkers specified in the PEP.
-
Literalnow de-duplicates parameters. -
Equality comparisons between
Literalobjects are now order independent. -
Literalcomparisons now respect types. For example,Literal[0] == Literal[False]previously evaluated toTrue. It is nowFalse. To support this change, the internally used type cache now supports differentiating types. -
Literalobjects will now raise aTypeErrorexception during equality comparisons if any of their parameters are nothashable. Note that declaringLiteralwith unhashable parameters will not throw an error:>>> from typing import Literal >>> Literal[{0}] >>> Literal[{0}] == Literal[{False}] Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: unhashable type: 'set'
(Contributed by Yurii Karabas in 42345.)
Add new function typing.is_typeddict to introspect if an annotation is a typing.TypedDict. (Contributed by Patrick Reader in 41792.)
Subclasses of typing.Protocol which only have data variables declared will now raise a TypeError when checked with isinstance unless they are decorated with ~typing.runtime_checkable. Previously, these checks passed silently. Users should decorate their subclasses with the !runtime_checkable decorator if they want runtime protocols. (Contributed by Yurii Karabas in 38908.)
Importing from the typing.io and typing.re submodules will now emit DeprecationWarning. These submodules have been deprecated since Python 3.8 and will be removed in a future version of Python. Anything belonging to those submodules should be imported directly from typing instead. (Contributed by Sebastian Rittau in 38291.)
unittest
Add new method ~unittest.TestCase.assertNoLogs to complement the existing ~unittest.TestCase.assertLogs. (Contributed by Kit Yan Choi in 39385.)
urllib.parse
Python versions earlier than Python 3.10 allowed using both ; and & as query parameter separators in urllib.parse.parse_qs and urllib.parse.parse_qsl. Due to security concerns, and to conform with newer W3C recommendations, this has been changed to allow only a single separator key, with & as the default. This change also affects !cgi.parse and !cgi.parse_multipart as they use the affected functions internally. For more details, please see their respective documentation. (Contributed by Adam Goldschmidt, Senthil Kumaran and Ken Jin in 42967.)
The presence of newline or tab characters in parts of a URL allows for some forms of attacks. Following the WHATWG specification that updates 3986, ASCII newline \n, \r and tab \t characters are stripped from the URL by the parser in urllib.parse preventing such attacks. The removal characters are controlled by a new module level variable urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE. (See 88048)
xml
Add a ~xml.sax.handler.LexicalHandler class to the xml.sax.handler module. (Contributed by Jonathan Gossage and Zackery Spytz in 35018.)
zipimport
Add ~zipimport.zipimporter.invalidate_caches method. (Contributed by Desmond Cheong in 14678.)
Optimizations
- Constructors
str,bytesandbytearrayare now faster (around 30--40% for small objects). (Contributed by Serhiy Storchaka in41334.) - The
runpymodule now imports fewer modules. Thepython3 -m module-namecommand startup time is 1.4x faster in average. On Linux,python3 -I -m module-nameimports 69 modules on Python 3.9, whereas it only imports 51 modules (-18) on Python 3.10. (Contributed by Victor Stinner in41006and41718.) - The
LOAD_ATTRinstruction now uses new "per opcode cache" mechanism. It is about 36% faster now for regular attributes and 44% faster for slots. (Contributed by Pablo Galindo and Yury Selivanov in42093and Guido van Rossum in42927, based on ideas implemented originally in PyPy and MicroPython.) - When building Python with
--enable-optimizationsnow-fno-semantic-interpositionis added to both the compile and link line. This speeds builds of the Python interpreter created with--enable-sharedwithgccby up to 30%. See this article for more details. (Contributed by Victor Stinner and Pablo Galindo in38980.) - Use a new output buffer management code for
bz2/lzma/zlibmodules, and add.readall()function to_compression.DecompressReaderclass. bz2 decompression is now 1.09x ~ 1.17x faster, lzma decompression 1.20x ~ 1.32x faster,GzipFile.read(-1)1.11x ~ 1.18x faster. (Contributed by Ma Lin, reviewed by Gregory P. Smith, in41486) - When using stringized annotations, annotations dicts for functions are no longer created when the function is created. Instead, they are stored as a tuple of strings, and the function object lazily converts this into the annotations dict on demand. This optimization cuts the CPU time needed to define an annotated function by half. (Contributed by Yurii Karabas and Inada Naoki in
42202.) - Substring search functions such as
str1 in str2andstr2.find(str1)now sometimes use Crochemore & Perrin's "Two-Way" string searching algorithm to avoid quadratic behavior on long strings. (Contributed by Dennis Sweeney in41972) - Add micro-optimizations to
_PyType_Lookup()to improve type attribute cache lookup performance in the common case of cache hits. This makes the interpreter 1.04 times faster on average. (Contributed by Dino Viehland in43452.) - The following built-in functions now support the faster
590vectorcall calling convention:map,filter,reversed,boolandfloat. (Contributed by Donghee Na and Jeroen Demeyer in43575,43287,41922,41873and41870.) ~bz2.BZ2Fileperformance is improved by removing internalRLock. This makes!BZ2Filethread unsafe in the face of multiple simultaneous readers or writers, just like its equivalent classes ingzipandlzmahave always been. (Contributed by Inada Naoki in43785.)
Deprecated
-
Currently Python accepts numeric literals immediately followed by keywords, for example
0in x,1or x,0if 1else 2. It allows confusing and ambiguous expressions like[0x1for x in y](which can be interpreted as[0x1 for x in y]or[0x1f or x in y]). Starting in this release, a deprecation warning is raised if the numeric literal is immediately followed by one of keywordsand,else,for,if,in,isandor. In future releases it will be changed to syntax warning, and finally to syntax error. (Contributed by Serhiy Storchaka in43833.) -
Starting in this release, there will be a concerted effort to begin cleaning up old import semantics that were kept for Python 2.7 compatibility. Specifically,
!find_loader/!find_module(superseded by~importlib.abc.MetaPathFinder.find_spec),importlib.abc.Loader.load_module(superseded by~importlib.abc.Loader.exec_module),!module_repr(which the import system takes care of for you), the__package__attribute (superseded by__spec__.parent), the__loader__attribute (superseded by__spec__.loader), and the__cached__attribute (superseded by__spec__.cached) will slowly be removed (as well as other classes and methods inimportlib).ImportWarningand/orDeprecationWarningwill be raised as appropriate to help identify code which needs updating during this transition. -
The entire
distutilsnamespace is deprecated, to be removed in Python 3.12. Refer to themodule changes <distutils-deprecated>section for more information. -
Non-integer arguments to
random.randrangeare deprecated. TheValueErroris deprecated in favor of aTypeError. (Contributed by Serhiy Storchaka and Raymond Hettinger in37319.) -
The various
load_module()methods ofimportlibhave been documented as deprecated since Python 3.6, but will now also trigger aDeprecationWarning. Use~importlib.abc.Loader.exec_moduleinstead. (Contributed by Brett Cannon in26131.) -
!zipimport.zipimporter.load_modulehas been deprecated in preference for~zipimport.zipimporter.exec_module. (Contributed by Brett Cannon in26131.) -
The use of
importlib.abc.Loader.load_moduleby the import system now triggers anImportWarningas~importlib.abc.Loader.exec_moduleis preferred. (Contributed by Brett Cannon in26131.) -
The use of
!importlib.abc.MetaPathFinder.find_moduleand!importlib.abc.PathEntryFinder.find_moduleby the import system now trigger anImportWarningasimportlib.abc.MetaPathFinder.find_specandimportlib.abc.PathEntryFinder.find_specare preferred, respectively. You can useimportlib.util.spec_from_loaderto help in porting. (Contributed by Brett Cannon in42134.) -
The use of
!importlib.abc.PathEntryFinder.find_loaderby the import system now triggers anImportWarningasimportlib.abc.PathEntryFinder.find_specis preferred. You can useimportlib.util.spec_from_loaderto help in porting. (Contributed by Brett Cannon in43672.) -
The various implementations of
!importlib.abc.MetaPathFinder.find_module(!importlib.machinery.BuiltinImporter.find_module,!importlib.machinery.FrozenImporter.find_module,!importlib.machinery.WindowsRegistryFinder.find_module,!importlib.machinery.PathFinder.find_module,!importlib.abc.MetaPathFinder.find_module),!importlib.abc.PathEntryFinder.find_module(!importlib.machinery.FileFinder.find_module), and!importlib.abc.PathEntryFinder.find_loader(!importlib.machinery.FileFinder.find_loader) now raiseDeprecationWarningand are slated for removal in Python 3.12 (previously they were documented as deprecated in Python 3.4). (Contributed by Brett Cannon in42135.) -
!importlib.abc.Finderis deprecated (including its sole method,!find_module). Bothimportlib.abc.MetaPathFinderandimportlib.abc.PathEntryFinderno longer inherit from the class. Users should inherit from one of these two classes as appropriate instead. (Contributed by Brett Cannon in42135.) -
The deprecations of
!imp,!importlib.find_loader,!importlib.util.set_package_wrapper,!importlib.util.set_loader_wrapper,!importlib.util.module_for_loader,!pkgutil.ImpImporter, and!pkgutil.ImpLoaderhave all been updated to list Python 3.12 as the slated version of removal (they began raisingDeprecationWarningin previous versions of Python). (Contributed by Brett Cannon in43720.) -
The import system now uses the
__spec__attribute on modules before falling back on!module_reprfor a module's__repr__()method. Removal of the use ofmodule_repr()is scheduled for Python 3.12. (Contributed by Brett Cannon in42137.) -
!importlib.abc.Loader.module_repr,!importlib.machinery.FrozenImporter.module_repr, and!importlib.machinery.BuiltinImporter.module_reprare deprecated and slated for removal in Python 3.12. (Contributed by Brett Cannon in42136.) -
sqlite3.OptimizedUnicodehas been undocumented and obsolete since Python 3.3, when it was made an alias tostr. It is now deprecated, scheduled for removal in Python 3.12. (Contributed by Erlend E. Aasland in42264.) -
The undocumented built-in function
sqlite3.enable_shared_cacheis now deprecated, scheduled for removal in Python 3.12. Its use is strongly discouraged by the SQLite3 documentation. See the SQLite3 docs for more details. If a shared cache must be used, open the database in URI mode using thecache=sharedquery parameter. (Contributed by Erlend E. Aasland in24464.) -
The following
threadingmethods are now deprecated:threading.currentThread=>threading.current_threadthreading.activeCount=>threading.active_countthreading.Condition.notifyAll=>threading.Condition.notify_allthreading.Event.isSet=>threading.Event.is_setthreading.Thread.setName=>threading.Thread.namethreading.Thread.getName=>threading.Thread.namethreading.Thread.isDaemon=>threading.Thread.daemonthreading.Thread.setDaemon=>threading.Thread.daemon
(Contributed by Jelle Zijlstra in
87889.) -
!pathlib.Path.link_tois deprecated and slated for removal in Python 3.12. Usepathlib.Path.hardlink_toinstead. (Contributed by Barney Gale in39950.) -
cgi.log()is deprecated and slated for removal in Python 3.12. (Contributed by Inada Naoki in41139.) -
The following
sslfeatures have been deprecated since Python 3.6, Python 3.7, or OpenSSL 1.1.0 and will be removed in 3.11:!OP_NO_SSLv2,!OP_NO_SSLv3,!OP_NO_TLSv1,!OP_NO_TLSv1_1,!OP_NO_TLSv1_2, and!OP_NO_TLSv1_3are replaced by~ssl.SSLContext.minimum_versionand~ssl.SSLContext.maximum_version.!PROTOCOL_SSLv2,!PROTOCOL_SSLv3,!PROTOCOL_SSLv23,!PROTOCOL_TLSv1,!PROTOCOL_TLSv1_1,!PROTOCOL_TLSv1_2, and!PROTOCOL_TLSare deprecated in favor of~ssl.PROTOCOL_TLS_CLIENTand~ssl.PROTOCOL_TLS_SERVER!wrap_socketis replaced byssl.SSLContext.wrap_socket!match_hostname!RAND_pseudo_bytes,!RAND_egd- NPN features like
ssl.SSLSocket.selected_npn_protocolandssl.SSLContext.set_npn_protocolsare replaced by ALPN.
-
The threading debug (
!PYTHONTHREADDEBUGenvironment variable) is deprecated in Python 3.10 and will be removed in Python 3.12. This feature requires adebug build of Python <debug-build>. (Contributed by Victor Stinner in44584.) -
Importing from the
typing.ioandtyping.resubmodules will now emitDeprecationWarning. These submodules will be removed in a future version of Python. Anything belonging to these submodules should be imported directly fromtypinginstead. (Contributed by Sebastian Rittau in38291.)
Removed
-
Removed special methods
__int__,__float__,__floordiv__,__mod__,__divmod__,__rfloordiv__,__rmod__and__rdivmod__of thecomplexclass. They always raised aTypeError. (Contributed by Serhiy Storchaka in41974.) -
The
ParserBase.error()method from the private and undocumented_markupbasemodule has been removed.html.parser.HTMLParseris the only subclass ofParserBaseand itserror()implementation was already removed in Python 3.5. (Contributed by Berker Peksag in31844.) -
Removed the
unicodedata.ucnhash_CAPIattribute which was an internal PyCapsule object. The related private_PyUnicode_Name_CAPIstructure was moved to the internal C API. (Contributed by Victor Stinner in42157.) -
Removed the
parsermodule, which was deprecated in 3.9 due to the switch to the new PEG parser, as well as all the C source and header files that were only being used by the old parser, includingnode.h,parser.h,graminit.handgrammar.h. -
Removed the Public C API functions
PyParser_SimpleParseStringFlags,PyParser_SimpleParseStringFlagsFilename,PyParser_SimpleParseFileFlagsandPyNode_Compilethat were deprecated in 3.9 due to the switch to the new PEG parser. -
Removed the
formattermodule, which was deprecated in Python 3.4. It is somewhat obsolete, little used, and not tested. It was originally scheduled to be removed in Python 3.6, but such removals were delayed until after Python 2.7 EOL. Existing users should copy whatever classes they use into their code. (Contributed by Donghee Na and Terry J. Reedy in42299.) -
Removed the
!PyModule_GetWarningsModulefunction that was useless now due to the!_warningsmodule was converted to a builtin module in 2.6. (Contributed by Hai Shi in42599.) -
Remove deprecated aliases to
collections-abstract-base-classesfrom thecollectionsmodule. (Contributed by Victor Stinner in37324.) -
The
loopparameter has been removed from most ofasyncio'shigh-level API <../library/asyncio-api-index>following deprecation in Python 3.8. The motivation behind this change is multifold:- This simplifies the high-level API.
- The functions in the high-level API have been implicitly getting the current thread's running event loop since Python 3.7. There isn't a need to pass the event loop to the API in most normal use cases.
- Event loop passing is error-prone especially when dealing with loops running in different threads.
Note that the low-level API will still accept
loop. Seechanges-python-apifor examples of how to replace existing code.(Contributed by Yurii Karabas, Andrew Svetlov, Yury Selivanov and Kyle Stanley in
42392.)
Porting to Python 3.10
This section lists previously described changes and other bugfixes that may require changes to your code.
Changes in the Python syntax
- Deprecation warning is now emitted when compiling previously valid syntax if the numeric literal is immediately followed by a keyword (like in
0in x). In future releases it will be changed to syntax warning, and finally to a syntax error. To get rid of the warning and make the code compatible with future releases just add a space between the numeric literal and the following keyword. (Contributed by Serhiy Storchaka in43833.)
Changes in the Python API
-
The etype parameters of the
~traceback.format_exception,~traceback.format_exception_only, and~traceback.print_exceptionfunctions in thetracebackmodule have been renamed to exc. (Contributed by Zackery Spytz and Matthias Bussonnier in26389.) -
atexit: At Python exit, if a callback registered withatexit.registerfails, its exception is now logged. Previously, only some exceptions were logged, and the last exception was always silently ignored. (Contributed by Victor Stinner in42639.) -
collections.abc.Callablegeneric now flattens type parameters, similar to whattyping.Callablecurrently does. This means thatcollections.abc.Callable[[int, str], str]will have__args__of(int, str, str); previously this was([int, str], str). Code which accesses the arguments viatyping.get_argsor__args__need to account for this change. Furthermore,TypeErrormay be raised for invalid forms of parameterizingcollections.abc.Callablewhich may have passed silently in Python 3.9. (Contributed by Ken Jin in42195.) -
socket.htonsandsocket.ntohsnow raiseOverflowErrorinstead ofDeprecationWarningif the given parameter will not fit in a 16-bit unsigned integer. (Contributed by Erlend E. Aasland in42393.) -
The
loopparameter has been removed from most ofasyncio'shigh-level API <../library/asyncio-api-index>following deprecation in Python 3.8.A coroutine that currently looks like this:
async def foo(loop): await asyncio.sleep(1, loop=loop)Should be replaced with this:
async def foo(): await asyncio.sleep(1)If
foo()was specifically designed not to run in the current thread's running event loop (e.g. running in another thread's event loop), consider usingasyncio.run_coroutine_threadsafeinstead.(Contributed by Yurii Karabas, Andrew Svetlov, Yury Selivanov and Kyle Stanley in
42392.) -
The
types.FunctionTypeconstructor now inherits the current builtins if the globals dictionary has no"__builtins__"key, rather than using{"None": None}as builtins: same behavior asevalandexecfunctions. Defining a function withdef function(...): ...in Python is not affected, globals cannot be overridden with this syntax: it also inherits the current builtins. (Contributed by Victor Stinner in42990.)
Changes in the C API
-
The C API functions
PyParser_SimpleParseStringFlags,PyParser_SimpleParseStringFlagsFilename,PyParser_SimpleParseFileFlags,PyNode_Compileand the type used by these functions,struct _node, were removed due to the switch to the new PEG parser.Source should be now be compiled directly to a code object using, for example,
Py_CompileString. The resulting code object can then be evaluated using, for example,PyEval_EvalCode.Specifically:
-
A call to
PyParser_SimpleParseStringFlagsfollowed byPyNode_Compilecan be replaced by callingPy_CompileString. -
There is no direct replacement for
PyParser_SimpleParseFileFlags. To compile code from aFILE *argument, you will need to read the file in C and pass the resulting buffer toPy_CompileString. -
To compile a file given a
char *filename, explicitly open the file, read it and compile the result. One way to do this is using theiomodule withPyImport_ImportModule,PyObject_CallMethod,PyBytes_AsStringandPy_CompileString, as sketched below. (Declarations and error handling are omitted.) :io_module = PyImport_ImportModule("io"); fileobject = PyObject_CallMethod(io_module, "open", "ss", filename, "rb"); source_bytes_object = PyObject_CallMethod(fileobject, "read", ""); result = PyObject_CallMethod(fileobject, "close", ""); source_buf = PyBytes_AsString(source_bytes_object); code = Py_CompileString(source_buf, filename, Py_file_input); -
For
FrameObjectobjects, the~frame.f_lastimember now represents a wordcode offset instead of a simple offset into the bytecode string. This means that this number needs to be multiplied by 2 to be used with APIs that expect a byte offset instead (likePyCode_Addr2Linefor example). Notice as well that the!f_lastimember ofFrameObjectobjects is not considered stable: please usePyFrame_GetLineNumberinstead.
-
CPython bytecode changes
- The
MAKE_FUNCTIONinstruction now accepts either a dict or a tuple of strings as the function's annotations. (Contributed by Yurii Karabas and Inada Naoki in42202.)
Build Changes
-
644: Python now requires OpenSSL 1.1.1 or newer. OpenSSL 1.0.2 is no longer supported. (Contributed by Christian Heimes in43669.) -
The C99 functions
snprintfandvsnprintfare now required to build Python. (Contributed by Victor Stinner in36020.) -
sqlite3requires SQLite 3.7.15 or higher. (Contributed by Sergey Fedoseev and Erlend E. Aasland in40744and40810.) -
The
atexitmodule must now always be built as a built-in module. (Contributed by Victor Stinner in42639.) -
Add
--disable-test-modulesoption to theconfigurescript: don't build nor install test modules. (Contributed by Xavier de Gaye, Thomas Petazzoni and Peixing Xin in27640.) -
Add
--with-wheel-pkg-dir=PATH option <--with-wheel-pkg-dir>to the./configurescript. If specified, theensurepipmodule looks forsetuptoolsandpipwheel packages in this directory: if both are present, these wheel packages are used instead of ensurepip bundled wheel packages.Some Linux distribution packaging policies recommend against bundling dependencies. For example, Fedora installs wheel packages in the
/usr/share/python-wheels/directory and don't install theensurepip._bundledpackage.(Contributed by Victor Stinner in
42856.) -
Add a new
configure --without-static-libpython option <--without-static-libpython>to not build thelibpythonMAJOR.MINOR.astatic library and not install thepython.oobject file.(Contributed by Victor Stinner in
43103.) -
The
configurescript now uses thepkg-configutility, if available, to detect the location of Tcl/Tk headers and libraries. As before, those locations can be explicitly specified with the--with-tcltk-includesand--with-tcltk-libsconfiguration options. (Contributed by Manolis Stamatogiannakis in42603.) -
Add
--with-openssl-rpathoption toconfigurescript. The option simplifies building Python with a custom OpenSSL installation, e.g../configure --with-openssl=/path/to/openssl --with-openssl-rpath=auto. (Contributed by Christian Heimes in43466.)
C API Changes
PEP 652: Maintaining the Stable ABI
The Stable ABI (Application Binary Interface) for extension modules or embedding Python is now explicitly defined. stable describes C API and ABI stability guarantees along with best practices for using the Stable ABI.
(Contributed by Petr Viktorin in 652 and 43795.)
New Features
-
The result of
PyNumber_Indexnow always has exact typeint. Previously, the result could have been an instance of a subclass ofint. (Contributed by Serhiy Storchaka in40792.) -
Add a new
~PyConfig.orig_argvmember to thePyConfigstructure: the list of the original command line arguments passed to the Python executable. (Contributed by Victor Stinner in23427.) -
The
PyDateTime_DATE_GET_TZINFOandPyDateTime_TIME_GET_TZINFOmacros have been added for accessing thetzinfoattributes ofdatetime.datetimeanddatetime.timeobjects. (Contributed by Zackery Spytz in30155.) -
Add a
PyCodec_Unregisterfunction to unregister a codec search function. (Contributed by Hai Shi in41842.) -
The
PyIter_Sendfunction was added to allow sending value into iterator without raisingStopIterationexception. (Contributed by Vladimir Matveev in41756.) -
Add
PyUnicode_AsUTF8AndSizeto the limited C API. (Contributed by Alex Gaynor in41784.) -
Add
PyModule_AddObjectReffunction: similar toPyModule_AddObjectbut don't steal a reference to the value on success. (Contributed by Victor Stinner in1635741.) -
Add
Py_NewRefandPy_XNewReffunctions to increment the reference count of an object and return the object. (Contributed by Victor Stinner in42262.) -
The
PyType_FromSpecWithBasesandPyType_FromModuleAndSpecfunctions now accept a single class as the bases argument. (Contributed by Serhiy Storchaka in42423.) -
The
PyType_FromModuleAndSpecfunction now accepts NULLtp_docslot. (Contributed by Hai Shi in41832.) -
The
PyType_GetSlotfunction can acceptstatic types <static-types>. (Contributed by Hai Shi and Petr Viktorin in41073.) -
Add a new
PySet_CheckExactfunction to the C-API to check if an object is an instance ofsetbut not an instance of a subtype. (Contributed by Pablo Galindo in43277.) -
Add
PyErr_SetInterruptExwhich allows passing a signal number to simulate. (Contributed by Antoine Pitrou in43356.) -
The limited C API is now supported if
Python is built in debug mode <debug-build>(if thePy_DEBUGmacro is defined). In the limited C API, thePy_INCREFandPy_DECREFfunctions are now implemented as opaque function calls, rather than accessing directly thePyObject.ob_refcntmember, if Python is built in debug mode and thePy_LIMITED_APImacro targets Python 3.10 or newer. It became possible to support the limited C API in debug mode because thePyObjectstructure is the same in release and debug mode since Python 3.8 (see36465).The limited C API is still not supported in the
--with-trace-refsspecial build (Py_TRACE_REFSmacro). (Contributed by Victor Stinner in43688.) -
Add the
Py_Is(x, y) <Py_Is>function to test if the x object is the y object, the same asx is yin Python. Add also thePy_IsNone,Py_IsTrue,Py_IsFalsefunctions to test if an object is, respectively, theNonesingleton, theTruesingleton or theFalsesingleton. (Contributed by Victor Stinner in43753.) -
Add new functions to control the garbage collector from C code:
PyGC_Enable(),PyGC_Disable(),PyGC_IsEnabled(). These functions allow to activate, deactivate and query the state of the garbage collector from C code without having to import thegcmodule. -
Add a new
Py_TPFLAGS_DISALLOW_INSTANTIATIONtype flag to disallow creating type instances. (Contributed by Victor Stinner in43916.) -
Add a new
Py_TPFLAGS_IMMUTABLETYPEtype flag for creating immutable type objects: type attributes cannot be set nor deleted. (Contributed by Victor Stinner and Erlend E. Aasland in43908.)
Porting to Python 3.10
-
The
PY_SSIZE_T_CLEANmacro must now be defined to usePyArg_ParseTupleandPy_BuildValueformats which use#:es#,et#,s#,u#,y#,z#,U#andZ#. Seearg-parsingand353. (Contributed by Victor Stinner in40943.) -
Since
Py_REFCNT()is changed to the inline static function,Py_REFCNT(obj) = new_refcntmust be replaced withPy_SET_REFCNT(obj, new_refcnt): seePy_SET_REFCNT()(available since Python 3.9). For backward compatibility, this macro can be used:#if PY_VERSION_HEX < 0x030900A4 # define Py_SET_REFCNT(obj, refcnt) ((Py_REFCNT(obj) = (refcnt)), (void)0) #endif(Contributed by Victor Stinner in
39573.) -
Calling
PyDict_GetItemwithoutGILheld had been allowed for historical reason. It is no longer allowed. (Contributed by Victor Stinner in40839.) -
PyUnicode_FromUnicode(NULL, size)andPyUnicode_FromStringAndSize(NULL, size)raiseDeprecationWarningnow. UsePyUnicode_Newto allocate Unicode object without initial data. (Contributed by Inada Naoki in36346.) -
The private
_PyUnicode_Name_CAPIstructure of the PyCapsule APIunicodedata.ucnhash_CAPIhas been moved to the internal C API. (Contributed by Victor Stinner in42157.) -
!Py_GetPath,!Py_GetPrefix,!Py_GetExecPrefix,!Py_GetProgramFullPath,!Py_GetPythonHomeand!Py_GetProgramNamefunctions now returnNULLif called beforePy_Initialize(before Python is initialized). Use the newinit-configAPI to get theinit-path-config. (Contributed by Victor Stinner in42260.) -
PyList_SET_ITEM,PyTuple_SET_ITEMandPyCell_SETmacros can no longer be used as l-value or r-value. For example,x = PyList_SET_ITEM(a, b, c)andPyList_SET_ITEM(a, b, c) = xnow fail with a compiler error. It prevents bugs likeif (PyList_SET_ITEM (a, b, c) < 0) ...test. (Contributed by Zackery Spytz and Victor Stinner in30459.) -
The non-limited API files
odictobject.h,parser_interface.h,picklebufobject.h,pyarena.h,pyctype.h,pydebug.h,pyfpe.h, andpytime.hhave been moved to theInclude/cpythondirectory. These files must not be included directly, as they are already included inPython.h; seeapi-includes. If they have been included directly, consider includingPython.hinstead. (Contributed by Nicholas Sim in35134.) -
Use the
Py_TPFLAGS_IMMUTABLETYPEtype flag to create immutable type objects. Do not rely onPy_TPFLAGS_HEAPTYPEto decide if a type object is mutable or not; check ifPy_TPFLAGS_IMMUTABLETYPEis set instead. (Contributed by Victor Stinner and Erlend E. Aasland in43908.) -
The undocumented function
Py_FrozenMainhas been removed from the limited API. The function is mainly useful for custom builds of Python. (Contributed by Petr Viktorin in26241.)
Deprecated
- The
PyUnicode_InternImmortal()function is now deprecated and will be removed in Python 3.12: usePyUnicode_InternInPlaceinstead. (Contributed by Victor Stinner in41692.)
Removed
-
Removed
Py_UNICODE_str*functions manipulatingPy_UNICODE*strings. (Contributed by Inada Naoki in41123.)Py_UNICODE_strlen: usePyUnicode_GetLengthorPyUnicode_GET_LENGTHPy_UNICODE_strcat: usePyUnicode_CopyCharactersorPyUnicode_FromFormatPy_UNICODE_strcpy,Py_UNICODE_strncpy: usePyUnicode_CopyCharactersorPyUnicode_SubstringPy_UNICODE_strcmp: usePyUnicode_ComparePy_UNICODE_strncmp: usePyUnicode_TailmatchPy_UNICODE_strchr,Py_UNICODE_strrchr: usePyUnicode_FindChar
-
Removed
PyUnicode_GetMax(). Please migrate to new (393) APIs. (Contributed by Inada Naoki in41103.) -
Removed
PyLong_FromUnicode(). Please migrate toPyLong_FromUnicodeObject. (Contributed by Inada Naoki in41103.) -
Removed
PyUnicode_AsUnicodeCopy(). Please usePyUnicode_AsUCS4CopyorPyUnicode_AsWideCharString(Contributed by Inada Naoki in41103.) -
Removed
_Py_CheckRecursionLimitvariable: it has been replaced byceval.recursion_limitof thePyInterpreterStatestructure. (Contributed by Victor Stinner in41834.) -
Removed undocumented macros
Py_ALLOW_RECURSIONandPy_END_ALLOW_RECURSIONand therecursion_criticalfield of thePyInterpreterStatestructure. (Contributed by Serhiy Storchaka in41936.) -
Removed the undocumented
PyOS_InitInterrupts()function. Initializing Python already implicitly installs signal handlers: seePyConfig.install_signal_handlers. (Contributed by Victor Stinner in41713.) -
Remove the
PyAST_Validate()function. It is no longer possible to build a AST object (mod_tytype) with the public C API. The function was already excluded from the limited C API (384). (Contributed by Victor Stinner in43244.) -
Remove the
symtable.hheader file and the undocumented functions:PyST_GetScope()PySymtable_Build()PySymtable_BuildObject()PySymtable_Free()Py_SymtableString()Py_SymtableStringObject()
The
Py_SymtableString()function was part the stable ABI by mistake but it could not be used, because thesymtable.hheader file was excluded from the limited C API.Use Python
symtablemodule instead. (Contributed by Victor Stinner in43244.) -
Remove
PyOS_ReadlineFunctionPointerfrom the limited C API headers and frompython3.dll, the library that provides the stable ABI on Windows. Since the function takes aFILE*argument, its ABI stability cannot be guaranteed. (Contributed by Petr Viktorin in43868.) -
Remove
ast.h,asdl.h, andPython-ast.hheader files. These functions were undocumented and excluded from the limited C API. Most names defined by these header files were not prefixed byPyand so could create names conflicts. For example,Python-ast.hdefined aYieldmacro which was conflict with theYieldname used by the Windows<winbase.h>header. Use the Pythonastmodule instead. (Contributed by Victor Stinner in43244.) -
Remove the compiler and parser functions using
struct _modtype, because the public AST C API was removed:PyAST_Compile()PyAST_CompileEx()PyAST_CompileObject()PyFuture_FromAST()PyFuture_FromASTObject()PyParser_ASTFromFile()PyParser_ASTFromFileObject()PyParser_ASTFromFilename()PyParser_ASTFromString()PyParser_ASTFromStringObject()
These functions were undocumented and excluded from the limited C API. (Contributed by Victor Stinner in
43244.) -
Remove the
pyarena.hheader file with functions:PyArena_New()PyArena_Free()PyArena_Malloc()PyArena_AddPyObject()
These functions were undocumented, excluded from the limited C API, and were only used internally by the compiler. (Contributed by Victor Stinner in
43244.) -
The
PyThreadState.use_tracingmember has been removed to optimize Python. (Contributed by Mark Shannon in43760.)
Notable security feature in 3.10.7
Converting between int and str in bases other than 2 (binary), 4, 8 (octal), 16 (hexadecimal), or 32 such as base 10 (decimal) now raises a ValueError if the number of digits in string form is above a limit to avoid potential denial of service attacks due to the algorithmic complexity. This is a mitigation for 2020-10735. This limit can be configured or disabled by environment variable, command line flag, or sys APIs. See the integer string conversion length limitation <int_max_str_digits> documentation. The default limit is 4300 digits in string form.
Notable security feature in 3.10.8
The deprecated !mailcap module now refuses to inject unsafe text (filenames, MIME types, parameters) into shell commands. Instead of using such text, it will warn and act as if a match was not found (or for test commands, as if the test failed). (Contributed by Petr Viktorin in 98966.)
Notable changes in 3.10.12
tarfile
- The extraction methods in
tarfile, andshutil.unpack_archive, have a new a filter argument that allows limiting tar features than may be surprising or dangerous, such as creating files outside the destination directory. Seetarfile-extraction-filterfor details. In Python 3.12, use without the filter argument will show aDeprecationWarning. In Python 3.14, the default will switch to'data'. (Contributed by Petr Viktorin in706.)
谢谢你的反馈!