What’s New In Python 3.11¶
- Editor:
Pablo Galindo Salgado
This article explains the new features in Python 3.11, compared to 3.10. Python 3.11 was released on October 24, 2022. For full details, see the changelog.
Summary – Release highlights¶
Python 3.11 is between 10-60% faster than Python 3.10. On average, we measured a 1.25x speedup on the standard benchmark suite. See Faster CPython for details.
New syntax features:
New built-in features:
New standard library modules:
Interpreter improvements:
New
-Pcommand line option andPYTHONSAFEPATHenvironment variable to disable automatically prepending potentially unsafe paths tosys.path
New typing features:
Important deprecations, removals and restrictions:
PEP 594: Many legacy standard library modules have been deprecated and will be removed in Python 3.13
New Features¶
PEP 657: Fine-grained error locations in tracebacks¶
When printing tracebacks, the interpreter will now point to the exact expression that caused the error, instead of just the line. For example:
Traceback (most recent call last):
File "distance.py", line 11, in <module>
print(manhattan_distance(p1, p2))
^^^^^^^^^^^^^^^^^^^^^^^^^^
File "distance.py", line 6, in manhattan_distance
return abs(point_1.x - point_2.x) + abs(point_1.y - point_2.y)
^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'x'
Previous versions of the interpreter would point to just the line, making it
ambiguous which object was None. These enhanced errors can also be helpful
when dealing with deeply nested dict objects and multiple function calls:
Traceback (most recent call last):
File "query.py", line 37, in <module>
magic_arithmetic('foo')
File "query.py", line 18, in magic_arithmetic
return add_counts(x) / 25
^^^^^^^^^^^^^
File "query.py", line 24, in add_counts
return 25 + query_user(user1) + query_user(user2)
^^^^^^^^^^^^^^^^^
File "query.py", line 32, in query_user
return 1 + query_count(db, response['a']['b']['c']['user'], retry=True)
~~~~~~~~~~~~~~~~~~^^^^^
TypeError: 'NoneType' object is not subscriptable
As well as complex arithmetic expressions:
Traceback (most recent call last):
File "calculation.py", line 54, in <module>
result = (x / y / z) * (a / b / c)
~~~~~~^~~
ZeroDivisionError: division by zero
Additionally, the information used by the enhanced traceback feature is made available via a general API, that can be used to correlate bytecode instructions with source code location. This information can be retrieved using:
The
codeobject.co_positions()method in Python.The
PyCode_Addr2Location()function in the C API.
See PEP 657 for more details. (Contributed by Pablo Galindo, Batuhan Taskaya and Ammar Askar in bpo-43950.)
Note
This feature requires storing column positions in Code Objects,
which may result in a small increase in interpreter memory usage
and disk usage for compiled Python files.
To avoid storing the extra information
and deactivate printing the extra traceback information,
use the -X no_debug_ranges command line option
or the PYTHONNODEBUGRANGES environment variable.
PEP 654: Exception Groups and except*¶
PEP 654 introduces language features that enable a program
to raise and handle multiple unrelated exceptions simultaneously.
The builtin types ExceptionGroup and BaseExceptionGroup
make it possible to group exceptions and raise them together,
and the new except* syntax generalizes
except to match subgroups of exception groups.
See PEP 654 for more details.
(Contributed by Irit Katriel in bpo-45292. PEP written by Irit Katriel, Yury Selivanov and Guido van Rossum.)
PEP 678: Exceptions can be enriched with notes¶
The add_note() method is added to BaseException.
It can be used to enrich exceptions with context information
that is not available at the time when the exception is raised.
The added notes appear in the default traceback.
See PEP 678 for more details.
(Contributed by Irit Katriel in bpo-45607. PEP written by Zac Hatfield-Dodds.)
Windows py.exe launcher improvements¶
The copy of the Python install manager included with Python 3.11 has been significantly
updated. It now supports company/tag syntax as defined in PEP 514 using the
-V:<company>/<tag> argument instead of the limited -<major>.<minor>.
This allows launching distributions other than PythonCore,
the one hosted on python.org.
When using -V: selectors, either company or tag can be omitted, but all
installs will be searched. For example, -V:OtherPython/ will select the
“best” tag registered for OtherPython, while -V:3.11 or -V:/3.11
will select the “best” distribution with tag 3.11.
When using the legacy -<major>, -<major>.<minor>,
-<major>-<bitness> or -<major>.<minor>-<bitness> arguments,
all existing behaviour should be preserved from past versions,
and only releases from PythonCore will be selected.
However, the -64 suffix now implies “not 32-bit” (not necessarily x86-64),
as there are multiple supported 64-bit platforms.
32-bit runtimes are detected by checking the runtime’s tag for a -32 suffix.
All releases of Python since 3.5 have included this in their 32-bit builds.
Other Language Changes¶
Starred unpacking expressions can now be used in
forstatements. (See bpo-46725 for more details.)Asynchronous comprehensions are now allowed inside comprehensions in asynchronous functions. Outer comprehensions implicitly become asynchronous in this case. (Contributed by Serhiy Storchaka in bpo-33346.)
A
TypeErroris now raised instead of anAttributeErrorinwithstatements andcontextlib.ExitStack.enter_context()for objects that do not support the context manager protocol, and inasync withstatements andcontextlib.AsyncExitStack.enter_async_context()for objects not supporting the asynchronous context manager protocol. (Contributed by Serhiy Storchaka in bpo-12022 and bpo-44471.)Added
object.__getstate__(), which provides the default implementation of the__getstate__()method.copying andpickleing instances of subclasses of builtin typesbytearray,set,frozenset,collections.OrderedDict,collections.deque,weakref.WeakSet, anddatetime.tzinfonow copies and pickles instance attributes implemented as slots. This change has an unintended side effect: It trips up a small minority of existing Python projects not expectingobject.__getstate__()to exist. See the later comments on gh-70766 for discussions of what workarounds such code may need. (Contributed by Serhiy Storchaka in bpo-26579.)
Added a
-Pcommand line option and aPYTHONSAFEPATHenvironment variable, which disable the automatic prepending tosys.pathof the script’s directory when running a script, or the current directory when using-cand-m. This ensures only stdlib and installed modules are picked up byimport, and avoids unintentionally or maliciously shadowing modules with those in a local (and typically user-writable) directory. (Contributed by Victor Stinner in gh-57684.)A
"z"option was added to the Format Specification Mini-Language that coerces negative to positive zero after rounding to the format precision. See PEP 682 for more details. (Contributed by John Belmonte in gh-90153.)Bytes are no longer accepted on
sys.path. Support broke sometime between Python 3.2 and 3.6, with no one noticing until after Python 3.10.0 was released. In addition, bringing back support would be problematic due to interactions between-bandsys.path_importer_cachewhen there is a mixture ofstrandbyteskeys. (Contributed by Thomas Grainger in gh-91181.)
Other CPython Implementation Changes¶
The special methods
__complex__()forcomplexand__bytes__()forbytesare implemented to support thetyping.SupportsComplexandtyping.SupportsBytesprotocols. (Contributed by Mark Dickinson and Donghee Na in bpo-24234.)siphash13is added as a new internal hashing algorithm. It has similar security properties assiphash24, but it is slightly faster for long inputs.str,bytes, and some other types now use it as the default algorithm forhash(). PEP 552 hash-based .pyc files now usesiphash13too. (Contributed by Inada Naoki in bpo-29410.)When an active exception is re-raised by a
raisestatement with no parameters, the traceback attached to this exception is now alwayssys.exc_info()[1].__traceback__. This means that changes made to the traceback in the currentexceptclause are reflected in the re-raised exception. (Contributed by Irit Katriel in bpo-45711.)The interpreter state’s representation of handled exceptions (aka
exc_infoor_PyErr_StackItem) now only has theexc_valuefield;exc_typeandexc_tracebackhave been removed, as they can be derived fromexc_value. (Contributed by Irit Katriel in bpo-45711.)A new command line option,
AppendPath, has been added for the Windows installer. It behaves similarly toPrependPath, but appends the install and scripts directories instead of prepending them. (Contributed by Bastian Neuburger in bpo-44934.)The
PyConfig.module_search_paths_setfield must now be set to1for initialization to usePyConfig.module_search_pathsto initializesys.path. Otherwise, initialization will recalculate the path and replace any values added tomodule_search_paths.The output of the
--helpoption now fits in 50 lines/80 columns. Information about Python environment variables and-Xoptions is now available using the respective--help-envand--help-xoptionsflags, and with the new--help-all. (Contributed by Éric Araujo in bpo-46142.)Converting between
intandstrin bases other than 2 (binary), 4, 8 (octal), 16 (hexadecimal), or 32 such as base 10 (decimal) now raises aValueErrorif 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 CVE 2020-10735. This limit can be configured or disabled by environment variable, command line flag, orsysAPIs. See the integer string conversion length limitation documentation. The default limit is 4300 digits in string form.
New Modules¶
Improved Modules¶
asyncio¶
Added the
TaskGroupclass, an asynchronous context manager holding a group of tasks that will wait for all of them upon exit. For new code this is recommended over usingcreate_task()andgather()directly. (Contributed by Yury Selivanov and others in gh-90908.)Added
timeout(), an asynchronous context manager for setting a timeout on asynchronous operations. For new code this is recommended over usingwait_for()directly. (Contributed by Andrew Svetlov in gh-90927.)Added the
Runnerclass, which exposes the machinery used byrun(). (Contributed by Andrew Svetlov in gh-91218.)Added the
Barrierclass to the synchronization primitives in the asyncio library, and the relatedBrokenBarrierErrorexception. (Contributed by Yves Duprat and Andrew Svetlov in gh-87518.)Added keyword argument all_errors to
asyncio.loop.create_connection()so that multiple connection errors can be raised as anExceptionGroup.Added the
asyncio.StreamWriter.start_tls()method for upgrading existing stream-based connections to TLS. (Contributed by Ian Good in bpo-34975.)Added raw datagram socket functions to the event loop:
sock_sendto(),sock_recvfrom()andsock_recvfrom_into(). These have implementations inSelectorEventLoopandProactorEventLoop. (Contributed by Alex Grönholm in bpo-46805.)Added
cancelling()anduncancel()methods toTask. These are primarily intended for internal use, notably byTaskGroup.
contextlib¶
dataclasses¶
datetime¶
Add
datetime.UTC, a convenience alias fordatetime.timezone.utc. (Contributed by Kabir Kwatra in gh-91973.)datetime.date.fromisoformat(),datetime.time.fromisoformat()anddatetime.datetime.fromisoformat()can now be used to parse most ISO 8601 formats (barring only those that support fractional hours and minutes). (Contributed by Paul Ganssle in gh-80010.)
enum¶
Renamed
EnumMetatoEnumType(EnumMetakept as an alias).Added
StrEnum, with members that can be used as (and must be) strings.Added
ReprEnum, which only modifies the__repr__()of members while returning their literal values (rather than names) for__str__()and__format__()(used bystr(),format()and f-strings).Changed
Enum.__format__()(the default forformat(),str.format()and f-strings) to always produce the same result asEnum.__str__(): for enums inheriting fromReprEnumit will be the member’s value; for all other enums it will be the enum and member name (e.g.Color.RED).Added a new boundary class parameter to
Flagenums and theFlagBoundaryenum with its options, to control how to handle out-of-range flag values.Added the
verify()enum decorator and theEnumCheckenum with its options, to check enum classes against several specific constraints.Added the
member()andnonmember()decorators, to ensure the decorated object is/is not converted to an enum member.Added the
property()decorator, which works likeproperty()except for enums. Use this instead oftypes.DynamicClassAttribute().Added the
global_enum()enum decorator, which adjusts__repr__()and__str__()to show values as members of their module rather than the enum class. For example,'re.ASCII'for theASCIImember ofre.RegexFlagrather than'RegexFlag.ASCII'.Enhanced
Flagto supportlen(), iteration andin/not inon its members. For example, the following now works:len(AFlag(3)) == 2 and list(AFlag(3)) == (AFlag.ONE, AFlag.TWO)Changed
EnumandFlagso that members are now defined before__init_subclass__()is called;dir()now includes methods, etc., from mixed-in data types.Changed
Flagto only consider primary values (power of two) canonical while composite values (3,6,10, etc.) are considered aliases; inverted flags are coerced to their positive equivalent.
fcntl¶
On FreeBSD, the
F_DUP2FDandF_DUP2FD_CLOEXECflags respectively are supported, the former equals todup2usage while the latter set theFD_CLOEXECflag in addition.
fractions¶
functools¶
functools.singledispatch()now supportstypes.UnionTypeandtyping.Unionas annotations to the dispatch argument.:>>> from functools import singledispatch >>> @singledispatch ... def fun(arg, verbose=False): ... if verbose: ... print("Let me just say,", end=" ") ... print(arg) ... >>> @fun.register ... def _(arg: int | float, verbose=False): ... if verbose: ... print("Strength in numbers, eh?", end=" ") ... print(arg) ... >>> from typing import Union >>> @fun.register ... def _(arg: Union[list, set], verbose=False): ... if verbose: ... print("Enumerate this:") ... for i, elem in enumerate(arg): ... print(i, elem) ...
(Contributed by Yurii Karabas in bpo-46014.)
gzip¶
The
gzip.compress()function is now faster when used with the mtime=0 argument as it delegates the compression entirely to a singlezlib.compress()operation. There is one side effect of this change: The gzip file header contains an “OS” byte in its header. That was traditionally always set to a value of 255 representing “unknown” by thegzipmodule. Now, when usingcompress()with mtime=0, it may be set to a different value by the underlying zlib C library Python was linked against. (See gh-112346 for details on the side effect.)
hashlib¶
hashlib.blake2b()andhashlib.blake2s()now prefer libb2 over Python’s vendored copy. (Contributed by Christian Heimes in bpo-47095.)The internal
_sha3module with SHA3 and SHAKE algorithms now uses tiny_sha3 instead of the Keccak Code Package to reduce code and binary size. Thehashlibmodule prefers optimized SHA3 and SHAKE implementations from OpenSSL. The change affects only installations without OpenSSL support. (Contributed by Christian Heimes in bpo-47098.)Add
hashlib.file_digest(), a helper function for efficient hashing of files or file-like objects. (Contributed by Christian Heimes in gh-89313.)
IDLE and idlelib¶
inspect¶
Add
getmembers_static()to return all members without triggering dynamic lookup via the descriptor protocol. (Contributed by Weipeng Hong in bpo-30533.)Add
ismethodwrapper()for checking if the type of an object is aMethodWrapperType. (Contributed by Hakan Çelik in bpo-29418.)Change the frame-related functions in the
inspectmodule to return newFrameInfoandTracebackclass instances (backwards compatible with the previous named tuple-like interfaces) that includes the extended PEP 657 position information (end line number, column and end column). The affected functions are:(Contributed by Pablo Galindo in gh-88116.)
locale¶
Add
locale.getencoding()to get the current locale encoding. It is similar tolocale.getpreferredencoding(False)but ignores the Python UTF-8 Mode.
logging¶
Added
getLevelNamesMapping()to return a mapping from logging level names (e.g.'CRITICAL') to the values of their corresponding Logging Levels (e.g.50, by default). (Contributed by Andrei Kulakovin in gh-88024.)Added a
createSocket()method toSysLogHandler, to matchSocketHandler.createSocket(). It is called automatically during handler initialization and when emitting an event, if there is no active socket. (Contributed by Kirill Pinchuk in gh-88457.)
math¶
Add
math.exp2(): return 2 raised to the power of x. (Contributed by Gideon Mitchell in bpo-45917.)Add
math.cbrt(): return the cube root of x. (Contributed by Ajith Ramachandran in bpo-44357.)The behaviour of two
math.pow()corner cases was changed, for consistency with the IEEE 754 specification. The operationsmath.pow(0.0, -math.inf)andmath.pow(-0.0, -math.inf)now returninf. Previously they raisedValueError. (Contributed by Mark Dickinson in bpo-44339.)The
math.nanvalue is now always available. (Contributed by Victor Stinner in bpo-46917.)
operator¶
A new function
operator.callhas been added, such thatoperator.call(obj, *args, **kwargs) == obj(*args, **kwargs). (Contributed by Antony Lee in bpo-44019.)
os¶
On Windows,
os.urandom()now usesBCryptGenRandom(), instead ofCryptGenRandom()which is deprecated. (Contributed by Donghee Na in bpo-44611.)
pathlib¶
re¶
Atomic grouping (
(?>...)) and possessive quantifiers (*+,++,?+,{m,n}+) are now supported in regular expressions. (Contributed by Jeffrey C. Jacobs and Serhiy Storchaka in bpo-433030.)
shutil¶
Add optional parameter dir_fd in
shutil.rmtree(). (Contributed by Serhiy Storchaka in bpo-46245.)
socket¶
Add CAN Socket support for NetBSD. (Contributed by Thomas Klausner in bpo-30512.)
create_connection()has an option to raise, in case of failure to connect, anExceptionGroupcontaining all errors instead of only raising the last error. (Contributed by Irit Katriel in bpo-29980.)
sqlite3¶
You can now disable the authorizer by passing
Nonetoset_authorizer(). (Contributed by Erlend E. Aasland in bpo-44491.)Collation name
create_collation()can now contain any Unicode character. Collation names with invalid characters now raiseUnicodeEncodeErrorinstead ofsqlite3.ProgrammingError. (Contributed by Erlend E. Aasland in bpo-44688.)sqlite3exceptions now include the SQLite extended error code assqlite_errorcodeand the SQLite error name assqlite_errorname. (Contributed by Aviv Palivoda, Daniel Shahaf, and Erlend E. Aasland in bpo-16379 and bpo-24139.)Add
setlimit()andgetlimit()tosqlite3.Connectionfor setting and getting SQLite limits by connection basis. (Contributed by Erlend E. Aasland in bpo-45243.)sqlite3now setssqlite3.threadsafetybased on the default threading mode the underlying SQLite library has been compiled with. (Contributed by Erlend E. Aasland in bpo-45613.)sqlite3C callbacks now use unraisable exceptions if callback tracebacks are enabled. Users can now register anunraisable hook handlerto improve their debug experience. (Contributed by Erlend E. Aasland in bpo-45828.)Fetch across rollback no longer raises
InterfaceError. Instead we leave it to the SQLite library to handle these cases. (Contributed by Erlend E. Aasland in bpo-44092.)Add
serialize()anddeserialize()tosqlite3.Connectionfor serializing and deserializing databases. (Contributed by Erlend E. Aasland in bpo-41930.)Add
create_window_function()tosqlite3.Connectionfor creating aggregate window functions. (Contributed by Erlend E. Aasland in bpo-34916.)Add
blobopen()tosqlite3.Connection.sqlite3.Bloballows incremental I/O operations on blobs. (Contributed by Aviv Palivoda and Erlend E. Aasland in bpo-24905.)
string¶
Add
get_identifiers()andis_valid()tostring.Template, which respectively return all valid placeholders, and whether any invalid placeholders are present. (Contributed by Ben Kehoe in gh-90465.)
sys¶
sys.exc_info()now derives thetypeandtracebackfields from thevalue(the exception instance), so when an exception is modified while it is being handled, the changes are reflected in the results of subsequent calls toexc_info(). (Contributed by Irit Katriel in bpo-45711.)Add
sys.exception()which returns the active exception instance (equivalent tosys.exc_info()[1]). (Contributed by Irit Katriel in bpo-46328.)Add the
sys.flags.safe_pathflag. (Contributed by Victor Stinner in gh-57684.)
sysconfig¶
Three new installation schemes (posix_venv, nt_venv and venv) were added and are used when Python creates new virtual environments or when it is running from a virtual environment. The first two schemes (posix_venv and nt_venv) are OS-specific for non-Windows and Windows, the venv is essentially an alias to one of them according to the OS Python runs on. This is useful for downstream distributors who modify
sysconfig.get_preferred_scheme(). Third party code that creates new virtual environments should use the new venv installation scheme to determine the paths, as doesvenv. (Contributed by Miro Hrončok in bpo-45413.)
tempfile¶
SpooledTemporaryFileobjects now fully implement the methods ofio.BufferedIOBaseorio.TextIOBase(depending on file mode). This lets them work correctly with APIs that expect file-like objects, such as compression modules. (Contributed by Carey Metcalfe in gh-70363.)
threading¶
On Unix, if the
sem_clockwait()function is available in the C library (glibc 2.30 and newer), thethreading.Lock.acquire()method now uses the monotonic clock (time.CLOCK_MONOTONIC) for the timeout, rather than using the system clock (time.CLOCK_REALTIME), to not be affected by system clock changes. (Contributed by Victor Stinner in bpo-41710.)
time¶
On Unix,
time.sleep()now uses theclock_nanosleep()ornanosleep()function, if available, which has a resolution of 1 nanosecond (10-9 seconds), rather than usingselect()which has a resolution of 1 microsecond (10-6 seconds). (Contributed by Benjamin Szőke and Victor Stinner in bpo-21302.)On Windows 8.1 and newer,
time.sleep()now uses a waitable timer based on high-resolution timers which has a resolution of 100 nanoseconds (10-7 seconds). Previously, it had a resolution of 1 millisecond (10-3 seconds). (Contributed by Benjamin Szőke, Donghee Na, Eryk Sun and Victor Stinner in bpo-21302 and bpo-45429.)
tkinter¶
Added method
info_patchlevel()which returns the exact version of the Tcl library as a named tuple similar tosys.version_info. (Contributed by Serhiy Storchaka in gh-91827.)
traceback¶
Add
traceback.StackSummary.format_frame_summary()to allow users to override which frames appear in the traceback, and how they are formatted. (Contributed by Ammar Askar in bpo-44569.)Add
traceback.TracebackException.print(), which prints the formattedTracebackExceptioninstance to a file. (Contributed by Irit Katriel in bpo-33809.)
typing¶
For major changes, see New Features Related to Type Hints.
Add
typing.assert_never()andtyping.Never.typing.assert_never()is useful for asking a type checker to confirm that a line of code is not reachable. At runtime, it raises anAssertionError. (Contributed by Jelle Zijlstra in gh-90633.)Add
typing.reveal_type(). This is useful for asking a type checker what type it has inferred for a given expression. At runtime it prints the type of the received value. (Contributed by Jelle Zijlstra in gh-90572.)Add
typing.assert_type(). This is useful for asking a type checker to confirm that the type it has inferred for a given expression matches the given type. At runtime it simply returns the received value. (Contributed by Jelle Zijlstra in gh-90638.)typing.TypedDicttypes can now be generic. (Contributed by Samodya Abeysiriwardane in gh-89026.)NamedTupletypes can now be generic. (Contributed by Serhiy Storchaka in bpo-43923.)Allow subclassing of
typing.Any. This is useful for avoiding type checker errors related to highly dynamic class, such as mocks. (Contributed by Shantanu Jain in gh-91154.)The
typing.final()decorator now sets the__final__attributed on the decorated object. (Contributed by Jelle Zijlstra in gh-90500.)The
typing.get_overloads()function can be used for introspecting the overloads of a function.typing.clear_overloads()can be used to clear all registered overloads of a function. (Contributed by Jelle Zijlstra in gh-89263.)The
__init__()method ofProtocolsubclasses is now preserved. (Contributed by Adrian Garcia Badarasco in gh-88970.)The representation of empty tuple types (
Tuple[()]) is simplified. This affects introspection, e.g.get_args(Tuple[()])now evaluates to()instead of((),). (Contributed by Serhiy Storchaka in gh-91137.)Loosen runtime requirements for type annotations by removing the callable check in the private
typing._type_checkfunction. (Contributed by Gregory Beauregard in gh-90802.)typing.get_type_hints()now supports evaluating strings as forward references in PEP 585 generic aliases. (Contributed by Niklas Rosenstein in gh-85542.)typing.get_type_hints()no longer addsOptionalto parameters withNoneas a default. (Contributed by Nikita Sobolev in gh-90353.)typing.get_type_hints()now supports evaluating bare stringifiedClassVarannotations. (Contributed by Gregory Beauregard in gh-90711.)typing.no_type_check()no longer modifies external classes and functions. It also now correctly marks classmethods as not to be type checked. (Contributed by Nikita Sobolev in gh-90729.)
unicodedata¶
The Unicode database has been updated to version 14.0.0. (Contributed by Benjamin Peterson in bpo-45190).
unittest¶
Added methods
enterContext()andenterClassContext()of classTestCase, methodenterAsyncContext()of classIsolatedAsyncioTestCaseand functionunittest.enterModuleContext(). (Contributed by Serhiy Storchaka in bpo-45046.)
venv¶
When new Python virtual environments are created, the venv sysconfig installation scheme is used to determine the paths inside the environment. When Python runs in a virtual environment, the same installation scheme is the default. That means that downstream distributors can change the default sysconfig install scheme without changing behavior of virtual environments. Third party code that also creates new virtual environments should do the same. (Contributed by Miro Hrončok in bpo-45413.)
warnings¶
warnings.catch_warnings()now accepts arguments forwarnings.simplefilter(), providing a more concise way to locally ignore warnings or convert them to errors. (Contributed by Zac Hatfield-Dodds in bpo-47074.)
zipfile¶
Added support for specifying member name encoding for reading metadata in a
ZipFile’s directory and file headers. (Contributed by Stephen J. Turnbull and Serhiy Storchaka in bpo-28080.)Added
ZipFile.mkdir()for creating new directories inside ZIP archives. (Contributed by Sam Ezeh in gh-49083.)Added
stem,suffixandsuffixestozipfile.Path. (Contributed by Miguel Brito in gh-88261.)
Optimizations¶
This section covers specific optimizations independent of the Faster CPython project, which is covered in its own section.
The compiler now optimizes simple printf-style % formatting on string literals containing only the format codes
%s,%rand%aand makes it as fast as a corresponding f-string expression. (Contributed by Serhiy Storchaka in bpo-28307.)Integer division (
//) is better tuned for optimization by compilers. It is now around 20% faster on x86-64 when dividing anintby a value smaller than2**30. (Contributed by Gregory P. Smith and Tim Peters in gh-90564.)sum()is now nearly 30% faster for integers smaller than2**30. (Contributed by Stefan Behnel in gh-68264.)Resizing lists is streamlined for the common case, speeding up
list.append()by ≈15% and simple list comprehensions by up to 20-30% (Contributed by Dennis Sweeney in gh-91165.)Dictionaries don’t store hash values when all keys are Unicode objects, decreasing
dictsize. For example,sys.getsizeof(dict.fromkeys("abcdefg"))is reduced from 352 bytes to 272 bytes (23% smaller) on 64-bit platforms. (Contributed by Inada Naoki in bpo-46845.)Using
asyncio.DatagramProtocolis now orders of magnitude faster when transferring large files over UDP, with speeds over 100 times higher for a ≈60 MiB file. (Contributed by msoxzw in gh-91487.)mathfunctionscomb()andperm()are now ≈10 times faster for large arguments (with a larger speedup for larger k). (Contributed by Serhiy Storchaka in bpo-37295.)The
statisticsfunctionsmean(),variance()andstdev()now consume iterators in one pass rather than converting them to alistfirst. This is twice as fast and can save substantial memory. (Contributed by Raymond Hettinger in gh-90415.)unicodedata.normalize()now normalizes pure-ASCII strings in constant time. (Contributed by Donghee Na in bpo-44987.)
Faster CPython¶
CPython 3.11 is an average of 25% faster than CPython 3.10 as measured with the pyperformance benchmark suite, when compiled with GCC on Ubuntu Linux. Depending on your workload, the overall speedup could be 10-60%.
This project focuses on two major areas in Python: Faster Startup and Faster Runtime. Optimizations not covered by this project are listed separately under Optimizations.
Faster Startup¶
Frozen imports / Static code objects¶
Python caches bytecode in the __pycache__ directory to speed up module loading.
Previously in 3.10, Python module execution looked like this:
Read __pycache__ -> Unmarshal -> Heap allocated code object -> Evaluate
In Python 3.11, the core modules essential for Python startup are “frozen”. This means that their Code Objects (and bytecode) are statically allocated by the interpreter. This reduces the steps in module execution process to:
Statically allocated code object -> Evaluate
Interpreter startup is now 10-15% faster in Python 3.11. This has a big impact for short-running programs using Python.
(Contributed by Eric Snow, Guido van Rossum and Kumar Aditya in many issues.)
Faster Runtime¶
Cheaper, lazy Python frames¶
Python frames, holding execution information, are created whenever Python calls a Python function. The following are new frame optimizations:
Streamlined the frame creation process.
Avoided memory allocation by generously re-using frame space on the C stack.
Streamlined the internal frame struct to contain only essential information. Frames previously held extra debugging and memory management information.
Old-style frame objects
are now created only when requested by debuggers
or by Python introspection functions such as sys._getframe() and
inspect.currentframe(). For most user code, no frame objects are
created at all. As a result, nearly all Python functions calls have sped
up significantly. We measured a 3-7% speedup in pyperformance.
(Contributed by Mark Shannon in bpo-44590.)
Inlined Python function calls¶
During a Python function call, Python will call an evaluating C function to interpret that function’s code. This effectively limits pure Python recursion to what’s safe for the C stack.
In 3.11, when CPython detects Python code calling another Python function, it sets up a new frame, and “jumps” to the new code inside the new frame. This avoids calling the C interpreting function altogether.
Most Python function calls now consume no C stack space, speeding them up.
In simple recursive functions like fibonacci or
factorial, we observed a 1.7x speedup. This also means recursive functions
can recurse significantly deeper
(if the user increases the recursion limit with sys.setrecursionlimit()).
We measured a 1-3% improvement in pyperformance.
(Contributed by Pablo Galindo and Mark Shannon in bpo-45256.)
PEP 659: Specializing Adaptive Interpreter¶
PEP 659 is one of the key parts of the Faster CPython project. The general idea is that while Python is a dynamic language, most code has regions where objects and types rarely change. This concept is known as type stability.
At runtime, Python will try to look for common patterns and type stability in the executing code. Python will then replace the current operation with a more specialized one. This specialized operation uses fast paths available only to those use cases/types, which generally outperform their generic counterparts. This also brings in another concept called inline caching, where Python caches the results of expensive operations directly in the bytecode.
The specializer will also combine certain common instruction pairs into one superinstruction, reducing the overhead during execution.
Python will only specialize when it sees code that is “hot” (executed multiple times). This prevents Python from wasting time on run-once code. Python can also de-specialize when code is too dynamic or when the use changes. Specialization is attempted periodically, and specialization attempts are not too expensive, allowing specialization to adapt to new circumstances.
(PEP written by Mark Shannon, with ideas inspired by Stefan Brunthaler. See PEP 659 for more information. Implementation by Mark Shannon and Brandt Bucher, with additional help from Irit Katriel and Dennis Sweeney.)
Operation |
Form |
Specialization |
Operation speedup (up to) |
Contributor(s) |
|---|---|---|---|---|
Binary operations |
|
Binary add, multiply and subtract for common types
such as |
10% |
Mark Shannon, Donghee Na, Brandt Bucher, Dennis Sweeney |
Subscript |
|
Subscripting container types such as Subscripting custom |
10-25% |
Irit Katriel, Mark Shannon |
Store subscript |
|
Similar to subscripting specialization above. |
10-25% |
Dennis Sweeney |
Calls |
|
Calls to common builtin (C) functions and types such
as |
20% |
Mark Shannon, Ken Jin |
Load global variable |
|
The object’s index in the globals/builtins namespace is cached. Loading globals and builtins require zero namespace lookups. |
Mark Shannon |
|
Load attribute |
|
Similar to loading global variables. The attribute’s index inside the class/object’s namespace is cached. In most cases, attribute loading will require zero namespace lookups. |
Mark Shannon |
|
Load methods for call |
|
The actual address of the method is cached. Method loading now has no namespace lookups – even for classes with long inheritance chains. |
10-20% |
Ken Jin, Mark Shannon |
Store attribute |
|
Similar to load attribute optimization. |
2% in pyperformance |
Mark Shannon |
Unpack Sequence |
|
Specialized for common containers such as
|
8% |
Brandt Bucher |
Misc¶
Objects now require less memory due to lazily created object namespaces. Their namespace dictionaries now also share keys more freely. (Contributed Mark Shannon in bpo-45340 and bpo-40116.)
“Zero-cost” exceptions are implemented, eliminating the cost of
trystatements when no exception is raised. (Contributed by Mark Shannon in bpo-40222.)A more concise representation of exceptions in the interpreter reduced the time required for catching an exception by about 10%. (Contributed by Irit Katriel in bpo-45711.)
re’s regular expression matching engine has been partially refactored, and now uses computed gotos (or “threaded code”) on supported platforms. As a result, Python 3.11 executes the pyperformance regular expression benchmarks up to 10% faster than Python 3.10. (Contributed by Brandt Bucher in gh-91404.)
FAQ¶
How should I write my code to utilize these speedups?¶
Write Pythonic code that follows common best practices; you don’t have to change your code. The Faster CPython project optimizes for common code patterns we observe.
Will CPython 3.11 use more memory?¶
Maybe not; we don’t expect memory use to exceed 20% higher than 3.10. This is offset by memory optimizations for frame objects and object dictionaries as mentioned above.
I don’t see any speedups in my workload. Why?¶
Certain code won’t have noticeable benefits. If your code spends most of its time on I/O operations, or already does most of its computation in a C extension library like NumPy, there won’t be significant speedups. This project currently benefits pure-Python workloads the most.
Furthermore, the pyperformance figures are a geometric mean. Even within the pyperformance benchmarks, certain benchmarks have slowed down slightly, while others have sped up by nearly 2x!
Is there a JIT compiler?¶
No. We’re still exploring other optimizations.
About¶
Faster CPython explores optimizations for CPython. The main team is funded by Microsoft to work on this full-time. Pablo Galindo Salgado is also funded by Bloomberg LP to work on the project part-time. Finally, many contributors are volunteers from the community.
CPython bytecode changes¶
The bytecode now contains inline cache entries,
which take the form of the newly-added CACHE instructions.
Many opcodes expect to be followed by an exact number of caches,
and instruct the interpreter to skip over them at runtime.
Populated caches can look like arbitrary instructions,
so great care should be taken when reading or modifying
raw, adaptive bytecode containing quickened data.
New opcodes¶
ASYNC_GEN_WRAP,RETURN_GENERATORandSEND, used in generators and co-routines.COPY_FREE_VARS, which avoids needing special caller-side code for closures.JUMP_BACKWARD_NO_INTERRUPT, for use in certain loops where handling interrupts is undesirable.MAKE_CELL, to create Cell Objects.CHECK_EG_MATCHandPREP_RERAISE_STAR, to handle the new exception groups and except* added in PEP 654.PUSH_EXC_INFO, for use in exception handlers.RESUME, a no-op, for internal tracing, debugging and optimization checks.
Replaced opcodes¶
Replaced Opcode(s) |
New Opcode(s) |
Notes |
|---|---|---|
BINARY_*INPLACE_* |
Replaced all numeric binary/in-place opcodes with a single opcode |
|
CALL_FUNCTIONCALL_FUNCTION_KWCALL_METHOD |
Decouples argument shifting for methods from handling of keyword arguments; allows better specialization of calls |
|
DUP_TOPDUP_TOP_TWOROT_TWOROT_THREEROT_FOURROT_N |
Stack manipulation instructions |
|
JUMP_IF_NOT_EXC_MATCH |
Now performs check but doesn’t jump |
|
JUMP_ABSOLUTEPOP_JUMP_IF_FALSEPOP_JUMP_IF_TRUE |
See [3];
|
|
SETUP_WITHSETUP_ASYNC_WITH |
|
|
All jump opcodes are now relative, including the
existing JUMP_IF_TRUE_OR_POP and JUMP_IF_FALSE_OR_POP.
The argument is now an offset from the current instruction
rather than an absolute location.
Changed/removed opcodes¶
Changed
MATCH_CLASSandMATCH_KEYSto no longer push an additional boolean value to indicate success/failure. Instead,Noneis pushed on failure in place of the tuple of extracted values.Changed opcodes that work with exceptions to reflect them now being represented as one item on the stack instead of three (see gh-89874).
Removed
COPY_DICT_WITHOUT_KEYS,GEN_START,POP_BLOCK,SETUP_FINALLYandYIELD_FROM.
Deprecated¶
This section lists Python APIs that have been deprecated in Python 3.11.
Deprecated C APIs are listed separately.
Language/Builtins¶
Chaining
classmethoddescriptors (introduced in bpo-19072) is now deprecated. It can no longer be used to wrap other descriptors such asproperty. The core design of this feature was flawed and caused a number of downstream problems. To “pass-through” aclassmethod, consider using the__wrapped__attribute that was added in Python 3.10. (Contributed by Raymond Hettinger in