What's New In Python 3.12
Editor
Adam Turner
* 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 issue 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 VCS log when researching a change.
This article explains the new features in Python 3.12, compared to 3.11. Python 3.12 was released on October 2, 2023. For full details, see the changelog <changelog>.
693 -- Python 3.12 Release Schedule
Summary -- Release highlights
Python 3.12 is a stable release of the Python programming language, with a mix of changes to the language and the standard library. The library changes focus on cleaning up deprecated APIs, usability, and correctness. Of note, the !distutils package has been removed from the standard library. Filesystem support in os and pathlib has seen a number of improvements, and several modules have better performance.
The language changes focus on usability, as f-strings <f-string> have had many limitations removed and 'Did you mean ...' suggestions continue to improve. The new type parameter syntax <whatsnew312-pep695> and type statement improve ergonomics for using generic types <generic type> and type aliases <type alias> with static type checkers.
This article doesn't attempt to provide a complete specification of all new features, but instead gives a convenient overview. For full details, you should refer to the documentation, such as the Library Reference <library-index> and Language Reference <reference-index>. If you want to understand the complete implementation and design rationale for a change, refer to the PEP for a particular new feature; but note that PEPs usually are not kept up-to-date once a feature has been fully implemented.
New syntax features:
PEP 695 <whatsnew312-pep695>, type parameter syntax and thetypestatement
New grammar features:
PEP 701 <whatsnew312-pep701>,f-strings <f-string>in the grammar
Interpreter improvements:
PEP 684 <whatsnew312-pep684>, a unique per-interpreterGIL <global interpreter lock>PEP 669 <whatsnew312-pep669>, low impact monitoring- Improved 'Did you mean ...' suggestions for
NameError,ImportError, andSyntaxErrorexceptions
Python data model improvements:
PEP 688 <whatsnew312-pep688>, using thebuffer protocol <bufferobjects>from Python
Significant improvements in the standard library:
- The
pathlib.Pathclass now supports subclassing - The
osmodule received several improvements for Windows support - A
command-line interface <sqlite3-cli>has been added to thesqlite3module isinstancechecks againstruntime-checkable protocols <typing.runtime_checkable>enjoy a speed up of between two and 20 times- The
asynciopackage has had a number of performance improvements, with some benchmarks showing a 75% speed up. - A
command-line interface <uuid-cli>has been added to theuuidmodule - Due to the changes in
PEP 701 <whatsnew312-pep701>, producing tokens via thetokenizemodule is up to 64% faster.
Security improvements:
- Replace the builtin
hashlibimplementations of SHA1, SHA3, SHA2-384, SHA2-512, and MD5 with formally verified code from the HACL* project. These builtin implementations remain as fallbacks that are only used when OpenSSL does not provide them.
C API improvements:
PEP 697 <whatsnew312-pep697>, unstable C API tierPEP 683 <whatsnew312-pep683>, immortal objects
CPython implementation improvements:
PEP 709 <whatsnew312-pep709>, comprehension inliningCPython support <perf_profiling>for the Linuxperfprofiler- Implement stack overflow protection on supported platforms
New typing features:
PEP 692 <whatsnew312-pep692>, using~typing.TypedDictto annotate**kwargs <argument>PEP 698 <whatsnew312-pep698>,typing.overridedecorator
Important deprecations, removals or restrictions:
623: Removewstrfrom Unicode objects in Python's C API, reducing the size of everystrobject by at least 8 bytes.632: Remove the!distutilspackage. Seethe migration guide <0632#migration-advice>for advice replacing the APIs it provided. The third-party Setuptools package continues to provide!distutils, if you still require it in Python 3.12 and beyond.95299: Do not pre-installsetuptoolsin virtual environments created withvenv. This means thatdistutils,setuptools,pkg_resources, andeasy_installwill no longer available by default; to access these runpip install setuptoolsin theactivated <venv-explanation>virtual environment.- The
!asynchat,!asyncore, and!impmodules have been removed, along with severalunittest.TestCasemethod aliases.
New Features
PEP 695: Type Parameter Syntax
Generic classes and functions under 484 were declared using a verbose syntax that left the scope of type parameters unclear and required explicit declarations of variance.
695 introduces a new, more compact and explicit way to create generic classes <generic-classes> and functions <generic-functions>:
def max[T](args: Iterable[T]) -> T:
...
class list[T]:
def __getitem__(self, index: int, /) -> T:
...
def append(self, element: T) -> None:
...
In addition, the PEP introduces a new way to declare type aliases <type-aliases> using the type statement, which creates an instance of ~typing.TypeAliasType:
type Point = tuple[float, float]
Type aliases can also be generic <generic-type-aliases>:
type Point[T] = tuple[T, T]
The new syntax allows declaring ~typing.TypeVarTuple and ~typing.ParamSpec parameters, as well as ~typing.TypeVar parameters with bounds or constraints:
type IntFunc[**P] = Callable[P, int] # ParamSpec
type LabeledTuple[*Ts] = tuple[str, *Ts] # TypeVarTuple
type HashableSequence[T: Hashable] = Sequence[T] # TypeVar with bound
type IntOrStrSequence[T: (int, str)] = Sequence[T] # TypeVar with constraints
The value of type aliases and the bound and constraints of type variables created through this syntax are evaluated only on demand (see lazy evaluation <lazy-evaluation>). This means type aliases are able to refer to other types defined later in the file.
Type parameters declared through a type parameter list are visible within the scope of the declaration and any nested scopes, but not in the outer scope. For example, they can be used in the type annotations for the methods of a generic class or in the class body. However, they cannot be used in the module scope after the class is defined. See type-params for a detailed description of the runtime semantics of type parameters.
In order to support these scoping semantics, a new kind of scope is introduced, the annotation scope <annotation-scopes>. Annotation scopes behave for the most part like function scopes, but interact differently with enclosing class scopes. In Python 3.13, annotations <annotation> will also be evaluated in annotation scopes.
See 695 for more details.
(PEP written by Eric Traut. Implementation by Jelle Zijlstra, Eric Traut, and others in 103764.)
PEP 701: Syntactic formalization of f-strings
701 lifts some restrictions on the usage of f-strings <f-string>. Expression components inside f-strings can now be any valid Python expression, including strings reusing the same quote as the containing f-string, multi-line expressions, comments, backslashes, and unicode escape sequences. Let's cover these in detail:
-
Quote reuse: in Python 3.11, reusing the same quotes as the enclosing f-string raises a
SyntaxError, forcing the user to either use other available quotes (like using double quotes or triple quotes if the f-string uses single quotes). In Python 3.12, you can now do things like this:>>> songs = ['Take me back to Eden', 'Alkaline', 'Ascensionism'] >>> f"This is the playlist: {", ".join(songs)}" 'This is the playlist: Take me back to Eden, Alkaline, Ascensionism'
Note that before this change there was no explicit limit in how f-strings can be nested, but the fact that string quotes cannot be reused inside the expression component of f-strings made it impossible to nest f-strings arbitrarily. In fact, this is the most nested f-string that could be written:
>>> f"""{f'''{f'{f"{1+1}"}'}'''}""" '2'
As now f-strings can contain any valid Python expression inside expression components, it is now possible to nest f-strings arbitrarily:
>>> f"{f"{f"{f"{f"{f"{1+1}"}"}"}"}"}" '2'
-
Multi-line expressions and comments: In Python 3.11, f-string expressions must be defined in a single line, even if the expression within the f-string could normally span multiple lines (like literal lists being defined over multiple lines), making them harder to read. In Python 3.12 you can now define f-strings spanning multiple lines, and add inline comments:
>>> f"This is the playlist: {", ".join([ ... 'Take me back to Eden', # My, my, those eyes like fire ... 'Alkaline', # Not acid nor alkaline ... 'Ascensionism' # Take to the broken skies at last ... ])}" 'This is the playlist: Take me back to Eden, Alkaline, Ascensionism'
-
Backslashes and unicode characters: before Python 3.12 f-string expressions couldn't contain any
\character. This also affected unicodeescape sequences <escape-sequences>(such as\N{snowman}) as these contain the\Npart that previously could not be part of expression components of f-strings. Now, you can define expressions like this:>>> print(f"This is the playlist: {"n".join(songs)}") This is the playlist: Take me back to Eden Alkaline Ascensionism >>> print(f"This is the playlist: {"N{BLACK HEART SUIT}".join(songs)}") This is the playlist: Take me back to Eden♥Alkaline♥Ascensionism
See 701 for more details.
As a positive side-effect of how this feature has been implemented (by parsing f-strings with the PEG parser <617>), now error messages for f-strings are more precise and include the exact location of the error. For example, in Python 3.11, the following f-string raises a SyntaxError:
>>> my_string = f"{x z y}" + f"{1 + 1}"
File "<stdin>", line 1
(x z y)
^^^
SyntaxError: f-string: invalid syntax. Perhaps you forgot a comma?
but the error message doesn't include the exact location of the error within the line and also has the expression artificially surrounded by parentheses. In Python 3.12, as f-strings are parsed with the PEG parser, error messages can be more precise and show the entire line:
>>> my_string = f"{x z y}" + f"{1 + 1}"
File "<stdin>", line 1
my_string = f"{x z y}" + f"{1 + 1}"
^^^
SyntaxError: invalid syntax. Perhaps you forgot a comma?
(Contributed by Pablo Galindo, Batuhan Taskaya, Lysandros Nikolaou, Cristián Maureira-Fredes and Marta Gómez in 102856. PEP written by Pablo Galindo, Batuhan Taskaya, Lysandros Nikolaou and Marta Gómez).
PEP 684: A Per-Interpreter GIL
684 introduces a per-interpreter GIL <global interpreter lock>, so that sub-interpreters may now be created with a unique GIL per interpreter. This allows Python programs to take full advantage of multiple CPU cores. This is currently only available through the C-API, though a Python API is anticipated for 3.13 <554>.
Use the new Py_NewInterpreterFromConfig function to create an interpreter with its own GIL:
PyInterpreterConfig config = {
.check_multi_interp_extensions = 1,
.gil = PyInterpreterConfig_OWN_GIL,
};
PyThreadState *tstate = NULL;
PyStatus status = Py_NewInterpreterFromConfig(&tstate, &config);
if (PyStatus_Exception(status)) {
return -1;
}
/* The new interpreter is now active in the current thread. */
For further examples how to use the C-API for sub-interpreters with a per-interpreter GIL, see Modules/_xxsubinterpretersmodule.c.
(Contributed by Eric Snow in 104210, etc.)
PEP 669: Low impact monitoring for CPython
669 defines a new API <sys.monitoring> for profilers, debuggers, and other tools to monitor events in CPython. It covers a wide range of events, including calls, returns, lines, exceptions, jumps, and more. This means that you only pay for what you use, providing support for near-zero overhead debuggers and coverage tools. See sys.monitoring for details.
(Contributed by Mark Shannon in 103082.)
PEP 688: Making the buffer protocol accessible in Python
688 introduces a way to use the buffer protocol <bufferobjects> from Python code. Classes that implement the ~object.__buffer__ method are now usable as buffer types.
The new collections.abc.Buffer ABC provides a standard way to represent buffer objects, for example in type annotations. The new inspect.BufferFlags enum represents the flags that can be used to customize buffer creation. (Contributed by Jelle Zijlstra in 102500.)
PEP 709: Comprehension inlining
Dictionary, list, and set comprehensions are now inlined, rather than creating a new single-use function object for each execution of the comprehension. This speeds up execution of a comprehension by up to two times. See 709 for further details.
Comprehension iteration variables remain isolated and don't overwrite a variable of the same name in the outer scope, nor are they visible after the comprehension. Inlining does result in a few visible behavior changes:
- There is no longer a separate frame for the comprehension in tracebacks, and tracing/profiling no longer shows the comprehension as a function call.
- The
symtablemodule will no longer produce child symbol tables for each comprehension; instead, the comprehension's locals will be included in the parent function's symbol table. - Calling
localsinside a comprehension now includes variables from outside the comprehension, and no longer includes the synthetic.0variable for the comprehension "argument". - A comprehension iterating directly over
locals()(e.g.[k for k in locals()]) may see "RuntimeError: dictionary changed size during iteration" when run under tracing (e.g. code coverage measurement). This is the same behavior already seen in e.g.for k in locals():. To avoid the error, first create a list of keys to iterate over:keys = list(locals()); [k for k in keys].
(Contributed by Carl Meyer and Vladimir Matveev in 709.)
Improved Error Messages
-
Modules from the standard library are now potentially suggested as part of the error messages displayed by the interpreter when a
NameErroris raised to the top level. (Contributed by Pablo Galindo in98254.)>>> sys.version_info Traceback (most recent call last): File "<stdin>", line 1, in <module> NameError: name 'sys' is not defined. Did you forget to import 'sys'?
-
Improve the error suggestion for
NameErrorexceptions for instances. Now if aNameErroris raised in a method and the instance has an attribute that's exactly equal to the name in the exception, the suggestion will includeself.<NAME>instead of the closest match in the method scope. (Contributed by Pablo Galindo in99139.)>>> class A: ... def __init__(self): ... self.blech = 1 ... ... def foo(self): ... somethin = blech ... >>> A().foo() Traceback (most recent call last): File "<stdin>", line 1 somethin = blech ^^^^^ NameError: name 'blech' is not defined. Did you mean: 'self.blech'?
-
Improve the
SyntaxErrorerror message when the user typesimport x from yinstead offrom y import x. (Contributed by Pablo Galindo in98931.)>>> import a.y.z from b.y.z Traceback (most recent call last): File "<stdin>", line 1 import a.y.z from b.y.z ^^^^^^^^^^^^^^^^^^^^^^^ SyntaxError: Did you mean to use 'from ... import ...' instead?
-
ImportErrorexceptions raised from failedfrom <module> import <name>statements now include suggestions for the value of<name>based on the available names in<module>. (Contributed by Pablo Galindo in91058.)>>> from collections import chainmap Traceback (most recent call last): File "<stdin>", line 1, in <module> ImportError: cannot import name 'chainmap' from 'collections'. Did you mean: 'ChainMap'?
New Features Related to Type Hints
This section covers major changes affecting type hints <484> and the typing module.
PEP 692: Using TypedDict for more precise **kwargs typing
Typing **kwargs in a function signature as introduced by 484 allowed for valid annotations only in cases where all of the **kwargs were of the same type.
692 specifies a more precise way of typing **kwargs by relying on typed dictionaries:
from typing import TypedDict, Unpack
class Movie(TypedDict):
name: str
year: int
def foo(**kwargs: Unpack[Movie]): ...
See 692 for more details.
(Contributed by Franek Magiera in 103629.)
PEP 698: Override Decorator for Static Typing
A new decorator typing.override has been added to the typing module. It indicates to type checkers that the method is intended to override a method in a superclass. This allows type checkers to catch mistakes where a method that is intended to override something in a base class does not in fact do so.
Example:
from typing import override
class Base:
def get_color(self) -> str:
return "blue"
class GoodChild(Base):
@override # ok: overrides Base.get_color
def get_color(self) -> str:
return "yellow"
class BadChild(Base):
@override # type checker error: does not override Base.get_color
def get_colour(self) -> str:
return "red"
See 698 for more details.
(Contributed by Steven Troxler in 101561.)
Other Language Changes
- The parser now raises
SyntaxErrorwhen parsing source code containing null bytes. (Contributed by Pablo Galindo in96670.) - A backslash-character pair that is not a valid escape sequence now generates a
SyntaxWarning, instead ofDeprecationWarning. For example,re.compile("\d+\.\d+")now emits aSyntaxWarning("\d"is an invalid escape sequence, use raw strings for regular expression:re.compile(r"\d+\.\d+")). In a future Python version,SyntaxErrorwill eventually be raised, instead ofSyntaxWarning. (Contributed by Victor Stinner in98401.) - Octal escapes with value larger than
0o377(ex:"\477"), deprecated in Python 3.11, now produce aSyntaxWarning, instead ofDeprecationWarning. In a future Python version they will be eventually aSyntaxError. (Contributed by Victor Stinner in98401.) - Variables used in the target part of comprehensions that are not stored to can now be used in assignment expressions (
:=). For example, in[(b := 1) for a, b.prop in some_iter], the assignment tobis now allowed. Note that assigning to variables stored to in the target part of comprehensions (likea) is still disallowed, as per572. (Contributed by Nikita Sobolev in100581.) - Exceptions raised in a class or type's
__set_name__method are no longer wrapped by aRuntimeError. Context information is added to the exception as a678note. (Contributed by Irit Katriel in77757.) - When a
try-except*construct handles the entireExceptionGroupand raises one other exception, that exception is no longer wrapped in anExceptionGroup. Also changed in version 3.11.4. (Contributed by Irit Katriel in103590.) - The Garbage Collector now runs only on the eval breaker mechanism of the Python bytecode evaluation loop instead of object allocations. The GC can also run when
PyErr_CheckSignalsis called so C extensions that need to run for a long time without executing any Python code also have a chance to execute the GC periodically. (Contributed by Pablo Galindo in97922.) - All builtin and extension callables expecting boolean parameters now accept arguments of any type instead of just
boolandint. (Contributed by Serhiy Storchaka in60203.) memoryviewnow supports the half-float type (the "e" format code). (Contributed by Donghee Na and Antoine Pitrou in90751.)sliceobjects are now hashable, allowing them to be used as dict keys and set items. (Contributed by Will Bradshaw, Furkan Onder, and Raymond Hettinger in101264.)sumnow uses Neumaier summation to improve accuracy and commutativity when summing floats or mixed ints and floats. (Contributed by Raymond Hettinger in100425.)ast.parsenow raisesSyntaxErrorinstead ofValueErrorwhen parsing source code containing null bytes. (Contributed by Pablo Galindo in96670.)- 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 filters <tarfile-extraction-filter>for details. In Python 3.14, the default will switch to'data'. (Contributed by Petr Viktorin in706.) types.MappingProxyTypeinstances are now hashable if the underlying mapping is hashable. (Contributed by Serhiy Storchaka in87995.)- Add
support for the perf profiler <perf_profiling>through the new environment variablePYTHONPERFSUPPORTand command-line option-X perf <-X>, as well as the newsys.activate_stack_trampoline,sys.deactivate_stack_trampoline, andsys.is_stack_trampoline_activefunctions. (Design by Pablo Galindo. Contributed by Pablo Galindo and Christian Heimes with contributions from Gregory P. Smith [Google] and Mark Shannon in96123.)
New Modules
- None.
Improved Modules
array
- The
array.arrayclass now supports subscripting, making it ageneric type. (Contributed by Jelle Zijlstra in98658.)
asyncio
- The performance of writing to sockets in
asynciohas been significantly improved.asyncionow avoids unnecessary copying when writing to sockets and uses~socket.socket.sendmsgif the platform supports it. (Contributed by Kumar Aditya in91166.) - Add
asyncio.eager_task_factoryandasyncio.create_eager_task_factoryfunctions to allow opting an event loop in to eager task execution, making some use-cases 2x to 5x faster. (Contributed by Jacob Bower & Itamar Oren in102853,104140, and104138) - On Linux,
asynciouses!asyncio.PidfdChildWatcherby default ifos.pidfd_openis available and functional instead of!asyncio.ThreadedChildWatcher. (Contributed by Kumar Aditya in98024.) - The event loop now uses the best available child watcher for each platform (
!asyncio.PidfdChildWatcherif supported and!asyncio.ThreadedChildWatcherotherwise), so manually configuring a child watcher is not recommended. (Contributed by Kumar Aditya in94597.) - Add loop_factory parameter to
asyncio.runto allow specifying a custom event loop factory. (Contributed by Kumar Aditya in99388.) - Add C implementation of
asyncio.current_taskfor 4x-6x speedup. (Contributed by Itamar Oren and Pranav Thulasiram Bhat in100344.) asyncio.iscoroutinenow returnsFalsefor generators asasynciodoes not support legacy generator-based coroutines. (Contributed by Kumar Aditya in102748.)asyncio.waitandasyncio.as_completednow accepts generators yielding tasks. (Contributed by Kumar Aditya in78530.)
calendar
- Add enums
calendar.Monthandcalendar.Daydefining months of the year and days of the week. (Contributed by Prince Roshan in103636.)
csv
- Add
csv.QUOTE_NOTNULLandcsv.QUOTE_STRINGSflags to provide finer grained control ofNoneand empty strings by~csv.readerand~csv.writerobjects.
dis
- Pseudo instruction opcodes (which are used by the compiler but do not appear in executable bytecode) are now exposed in the
dismodule.HAVE_ARGUMENTis still relevant to real opcodes, but it is not useful for pseudo instructions. Use the newdis.hasargcollection instead. (Contributed by Irit Katriel in94216.) - Add the
dis.hasexccollection to signify instructions that set an exception handler. (Contributed by Irit Katriel in94216.)
fractions
- Objects of type
fractions.Fractionnow support float-style formatting. (Contributed by Mark Dickinson in100161.)
importlib.resources
importlib.resources.as_filenow supports resource directories. (Contributed by Jason R. Coombs in97930.)- Rename first parameter of
importlib.resources.filesto anchor. (Contributed by Jason R. Coombs in100598.)
inspect
- Add
inspect.markcoroutinefunctionto mark sync functions that return acoroutinefor use withinspect.iscoroutinefunction. (Contributed by Carlton Gibson in99247.) - Add
inspect.getasyncgenstateandinspect.getasyncgenlocalsfor determining the current state of asynchronous generators. (Contributed by Thomas Krennwallner in79940.) - The performance of
inspect.getattr_statichas been considerably improved. Most calls to the function should be at least 2x faster than they were in Python 3.11. (Contributed by Alex Waygood in103193.)
itertools
- Add
itertools.batchedfor collecting into even-sized tuples where the last batch may be shorter than the rest. (Contributed by Raymond Hettinger in98363.)
math
- Add
math.sumprodfor computing a sum of products. (Contributed by Raymond Hettinger in100485.) - Extend
math.nextafterto include a steps argument for moving up or down multiple steps at a time. (Contributed by Matthias Goergens, Mark Dickinson, and Raymond Hettinger in94906.)
os
- Add
os.PIDFD_NONBLOCKto open a file descriptor for a process withos.pidfd_openin non-blocking mode. (Contributed by Kumar Aditya in93312.) os.DirEntrynow includes anos.DirEntry.is_junctionmethod to check if the entry is a junction. (Contributed by Charles Machalow in99547.)- Add
os.listdrives,os.listvolumesandos.listmountsfunctions on Windows for enumerating drives, volumes and mount points. (Contributed by Steve Dower in102519.) os.statandos.lstatare now more accurate on Windows. Thest_birthtimefield will now be filled with the creation time of the file, andst_ctimeis deprecated but still contains the creation time (but in the future will return the last metadata change, for consistency with other platforms).st_devmay be up to 64 bits andst_inoup to 128 bits depending on your file system, andst_rdevis always set to zero rather than incorrect values. Both functions may be significantly faster on newer releases of Windows. (Contributed by Steve Dower in99726.)
os.path
- Add
os.path.isjunctionto check if a given path is a junction. (Contributed by Charles Machalow in99547.) - Add
os.path.splitrootto split a path into a triad(drive, root, tail). (Contributed by Barney Gale in101000.)
pathlib
- Add support for subclassing
pathlib.PurePathandpathlib.Path, plus their Posix- and Windows-specific variants. Subclasses may override thepathlib.PurePath.with_segmentsmethod to pass information between path instances. - Add
pathlib.Path.walkfor walking the directory trees and generating all file or directory names within them, similar toos.walk. (Contributed by Stanislav Zmiev in90385.) - Add walk_up optional parameter to
pathlib.PurePath.relative_toto allow the insertion of..entries in the result; this behavior is more consistent withos.path.relpath. (Contributed by Domenico Ragusa in84538.) - Add
pathlib.Path.is_junctionas a proxy toos.path.isjunction. (Contributed by Charles Machalow in99547.) - Add case_sensitive optional parameter to
pathlib.Path.glob,pathlib.Path.rglobandpathlib.PurePath.matchfor matching the path's case sensitivity, allowing for more precise control over the matching process.
platform
- Add support for detecting Windows 11 and Windows Server releases past 2012. Previously, lookups on Windows Server platforms newer than Windows Server 2012 and on Windows 11 would return
Windows-10. (Contributed by Steve Dower in89545.)
pdb
- Add convenience variables to hold values temporarily for debug session and provide quick access to values like the current frame or the return value. (Contributed by Tian Gao in
103693.)
random
- Add
random.binomialvariate. (Contributed by Raymond Hettinger in81620.) - Add a default of
lambd=1.0torandom.expovariate. (Contributed by Raymond Hettinger in100234.)
shutil
-
shutil.make_archivenow passes the root_dir argument to custom archivers which support it. In this case it no longer temporarily changes the current working directory of the process to root_dir to perform archiving. (Contributed by Serhiy Storchaka in74696.) -
shutil.rmtreenow accepts a new argument onexc which is an error handler like onerror but which expects an exception instance rather than a (typ, val, tb) triplet. onerror is deprecated. (Contributed by Irit Katriel in102828.) -
shutil.whichnow consults the PATHEXT environment variable to find matches within PATH on Windows even when the given cmd includes a directory component. (Contributed by Charles Machalow in103179.)shutil.whichwill callNeedCurrentDirectoryForExePathWwhen querying for executables on Windows to determine if the current working directory should be prepended to the search path. (Contributed by Charles Machalow in103179.)shutil.whichwill return a path matching the cmd with a component fromPATHEXTprior to a direct match elsewhere in the search path on Windows. (Contributed by Charles Machalow in103179.)
sqlite3
- Add a
command-line interface <sqlite3-cli>. (Contributed by Erlend E. Aasland in77617.) - Add the
sqlite3.Connection.autocommitattribute tosqlite3.Connectionand the autocommit parameter tosqlite3.connectto control249-complianttransaction handling <sqlite3-transaction-control-autocommit>. (Contributed by Erlend E. Aasland in83638.) - Add entrypoint keyword-only parameter to
sqlite3.Connection.load_extension, for overriding the SQLite extension entry point. (Contributed by Erlend E. Aasland in103015.) - Add
sqlite3.Connection.getconfigandsqlite3.Connection.setconfigtosqlite3.Connectionto make configuration changes to a database connection. (Contributed by Erlend E. Aasland in103489.)
statistics
- Extend
statistics.correlationto include as arankedmethod for computing the Spearman correlation of ranked data. (Contributed by Raymond Hettinger in95861.)
sys
- Add the
sys.monitoringnamespace to expose the newPEP 669 <whatsnew312-pep669>monitoring API. (Contributed by Mark Shannon in103082.) - Add
sys.activate_stack_trampolineandsys.deactivate_stack_trampolinefor activating and deactivating stack profiler trampolines, andsys.is_stack_trampoline_activefor querying if stack profiler trampolines are active. (Contributed by Pablo Galindo and Christian Heimes with contributions from Gregory P. Smith [Google] and Mark Shannon in96123.) - Add
sys.last_excwhich holds the last unhandled exception that was raised (for post-mortem debugging use cases). Deprecate the three fields that have the same information in its legacy form:sys.last_type,sys.last_valueandsys.last_traceback. (Contributed by Irit Katriel in102778.) sys._current_exceptionsnow returns a mapping from thread-id to an exception instance, rather than to a(typ, exc, tb)tuple. (Contributed by Irit Katriel in103176.)sys.setrecursionlimitandsys.getrecursionlimit. The recursion limit now applies only to Python code. Builtin functions do not use the recursion limit, but are protected by a different mechanism that prevents recursion from causing a virtual machine crash.
tempfile
- The
tempfile.NamedTemporaryFilefunction has a new optional parameter delete_on_close (Contributed by Evgeny Zorin in58451.) tempfile.mkdtempnow always returns an absolute path, even if the argument provided to the dir parameter is a relative path.
threading
- Add
threading.settrace_all_threadsandthreading.setprofile_all_threadsthat allow to set tracing and profiling functions in all running threads in addition to the calling one. (Contributed by Pablo Galindo in93503.)
tkinter
tkinter.Canvas.coords()now flattens its arguments. It now accepts not only coordinates as separate arguments (x1, y1, x2, y2, ...) and a sequence of coordinates ([x1, y1, x2, y2, ...]), but also coordinates grouped in pairs ((x1, y1), (x2, y2), ...and[(x1, y1), (x2, y2), ...]), likecreate_*()methods. (Contributed by Serhiy Storchaka in94473.)
tokenize
- The
tokenizemodule includes the changes introduced in701. (Contributed by Marta Gómez Macías and Pablo Galindo in102856.) Seewhatsnew312-porting-to-python312for more information on the changes to thetokenizemodule.
types
- Add
types.get_original_basesto allow for further introspection ofuser-defined-genericswhen subclassed. (Contributed by James Hilton-Balfe and Alex Waygood in101827.)
typing
-
isinstancechecks againstruntime-checkable protocols <typing.runtime_checkable>now useinspect.getattr_staticrather thanhasattrto lookup whether attributes exist. This means that descriptors and~object.__getattr__methods are no longer unexpectedly evaluated duringisinstance()checks against runtime-checkable protocols. However, it may also mean that some objects which used to be considered instances of a runtime-checkable protocol may no longer be considered instances of that protocol on Python 3.12+, and vice versa. Most users are unlikely to be affected by this change. (Contributed by Alex Waygood in102433.) -
The members of a runtime-checkable protocol are now considered "frozen" at runtime as soon as the class has been created. Monkey-patching attributes onto a runtime-checkable protocol will still work, but will have no impact on
isinstancechecks comparing objects to the protocol. For example:>>> from typing import Protocol, runtime_checkable >>> @runtime_checkable ... class HasX(Protocol): ... x = 1 ... >>> class Foo: ... ... >>> f = Foo() >>> isinstance(f, HasX) False >>> f.x = 1 >>> isinstance(f, HasX) True >>> HasX.y = 2 >>> isinstance(f, HasX) # unchanged, even though HasX now also has a "y" attribute TrueThis change was made in order to speed up
isinstance()checks against runtime-checkable protocols. -
The performance profile of
isinstancechecks againstruntime-checkable protocols <typing.runtime_checkable>has changed significantly. Mostisinstance()checks against protocols with only a few members should be at least 2x faster than in 3.11, and some may be 20x faster or more. However,isinstance()checks against protocols with many members may be slower than in Python 3.11. (Contributed by Alex Waygood in74690and103193.) -
All
typing.TypedDictandtyping.NamedTupleclasses now have the__orig_bases__attribute. (Contributed by Adrian Garcia Badaracco in103699.) -
Add
frozen_defaultparameter totyping.dataclass_transform. (Contributed by Erik De Bonte in99957.)
unicodedata
- The Unicode database has been updated to version 15.0.0. (Contributed by Benjamin Peterson in
96734).
unittest
Add a --durations command line option, showing the N slowest test cases:
python3 -m unittest --durations=3 lib.tests.test_threading
.....
Slowest test durations
----------------------------------------------------------------------
1.210s test_timeout (Lib.test.test_threading.BarrierTests)
1.003s test_default_timeout (Lib.test.test_threading.BarrierTests)
0.518s test_timeout (Lib.test.test_threading.EventTests)
(0.000 durations hidden. Use -v to show these durations.)
----------------------------------------------------------------------
Ran 158 tests in 9.869s
OK (skipped=3)
(Contributed by Giampaolo Rodola in 48330)
uuid
- Add a
command-line interface <uuid-cli>. (Contributed by Adam Chhina in88597.)
Optimizations
- Remove
wstrandwstr_lengthmembers from Unicode objects. It reduces object size by 8 or 16 bytes on 64bit platform. (623) (Contributed by Inada Naoki in92536.) - Add experimental support for using the BOLT binary optimizer in the build process, which improves performance by 1-5%. (Contributed by Kevin Modzelewski in
90536and tuned by Donghee Na in101525) - Speed up the regular expression substitution (functions
re.subandre.subnand corresponding!re.Patternmethods) for replacement strings containing group references by 2--3 times. (Contributed by Serhiy Storchaka in91524.) - Speed up
asyncio.Taskcreation by deferring expensive string formatting. (Contributed by Itamar Oren in103793.) - The
tokenize.tokenizeandtokenize.generate_tokensfunctions are up to 64% faster as a side effect of the changes required to cover701in thetokenizemodule. (Contributed by Marta Gómez Macías and Pablo Galindo in102856.) - Speed up
supermethod calls and attribute loads via the newLOAD_SUPER_ATTRinstruction. (Contributed by Carl Meyer and Vladimir Matveev in103497.)
CPython bytecode changes
- Remove the
!LOAD_METHODinstruction. It has been merged intoLOAD_ATTR.LOAD_ATTRwill now behave like the old!LOAD_METHODinstruction if the low bit of its oparg is set. (Contributed by Ken Jin in93429.) - Remove the
!JUMP_IF_FALSE_OR_POPand!JUMP_IF_TRUE_OR_POPinstructions. (Contributed by Irit Katriel in102859.) - Remove the
!PRECALLinstruction. (Contributed by Mark Shannon in92925.) - Add the
BINARY_SLICEandSTORE_SLICEinstructions. (Contributed by Mark Shannon in94163.) - Add the
CALL_INTRINSIC_1instructions. (Contributed by Mark Shannon in99005.) - Add the
CALL_INTRINSIC_2instruction. (Contributed by Irit Katriel in101799.) - Add the
CLEANUP_THROWinstruction. (Contributed by Brandt Bucher in90997.) - Add the
!END_SENDinstruction. (Contributed by Mark Shannon in103082.) - Add the
LOAD_FAST_AND_CLEARinstruction as part of the implementation of709. (Contributed by Carl Meyer in101441.) - Add the
LOAD_FAST_CHECKinstruction. (Contributed by Dennis Sweeney in93143.) - Add the
LOAD_FROM_DICT_OR_DEREF,LOAD_FROM_DICT_OR_GLOBALS, andLOAD_LOCALSopcodes as part of the implementation of695. Remove the!LOAD_CLASSDEREFopcode, which can be replaced withLOAD_LOCALSplusLOAD_FROM_DICT_OR_DEREF. (Contributed by Jelle Zijlstra in103764.) - Add the
LOAD_SUPER_ATTRinstruction. (Contributed by Carl Meyer and Vladimir Matveev in103497.) - Add the
RETURN_CONSTinstruction. (Contributed by Wenyang Wang in101632.)
Demos and Tools
- Remove the
Tools/demo/directory which contained old demo scripts. A copy can be found in the old-demos project. (Contributed by Victor Stinner in97681.) - Remove outdated example scripts of the
Tools/scripts/directory. A copy can be found in the old-demos project. (Contributed by Victor Stinner in97669.)
Deprecated
-
argparse: The type, choices, and metavar parameters of!argparse.BooleanOptionalActionare deprecated and will be removed in 3.14. (Contributed by Nikita Sobolev in92248.) -
ast: The followingastfeatures have been deprecated in documentation since Python 3.8, now cause aDeprecationWarningto be emitted at runtime when they are accessed or used, and will be removed in Python 3.14:!ast.Num!ast.Str!ast.Bytes!ast.NameConstant!ast.Ellipsis
Use
ast.Constantinstead. (Contributed by Serhiy Storchaka in90953.) -
asyncio:- The child watcher classes
!asyncio.MultiLoopChildWatcher,!asyncio.FastChildWatcher,!asyncio.AbstractChildWatcherand!asyncio.SafeChildWatcherare deprecated and will be removed in Python 3.14. (Contributed by Kumar Aditya in94597.) !asyncio.set_child_watcher,!asyncio.get_child_watcher,!asyncio.AbstractEventLoopPolicy.set_child_watcherand!asyncio.AbstractEventLoopPolicy.get_child_watcherare deprecated and will be removed in Python 3.14. (Contributed by Kumar Aditya in94597.)- The
~asyncio.get_event_loopmethod of the default event loop policy now emits aDeprecationWarningif there is no current event loop set and it decides to create one. (Contributed by Serhiy Storchaka and Guido van Rossum in100160.)
- The child watcher classes
-
calendar:calendar.Januaryandcalendar.Februaryconstants are deprecated and replaced bycalendar.JANUARYandcalendar.FEBRUARY. (Contributed by Prince Roshan in103636.) -
collections.abc: Deprecatedcollections.abc.ByteString.Use
isinstance(obj, collections.abc.Buffer)to test ifobjimplements thebuffer protocol <bufferobjects>at runtime. For use in type annotations, either use~collections.abc.Bufferor a union that explicitly specifies the types your code supports (e.g.,bytes | bytearray | memoryview).!ByteStringwas originally intended to be an abstract class that would serve as a supertype of bothbytesandbytearray. However, since the ABC never had any methods, knowing that an object was an instance of!ByteStringnever actually told you anything useful about the object. Other common buffer types such asmemoryviewwere also never understood as subtypes of!ByteString(either at runtime or by static type checkers).See
PEP 688 <688#current-options>for more details. (Contributed by Shantanu Jain in91896.) -
datetime:datetime.datetime's~datetime.datetime.utcnowand~datetime.datetime.utcfromtimestampare deprecated and will be removed in a future version. Instead, use timezone-aware objects to represent datetimes in UTC: respectively, call~datetime.datetime.nowand~datetime.datetime.fromtimestampwith the tz parameter set todatetime.UTC. (Contributed by Paul Ganssle in103857.) -
email: Deprecate the isdst parameter inemail.utils.localtime. (Contributed by Alan Williams in72346.) -
importlib.abc: Deprecated the following classes, scheduled for removal in Python 3.14:!importlib.abc.ResourceReader!importlib.abc.Traversable!importlib.abc.TraversableResources
Use
importlib.resources.abcclasses instead:importlib.resources.abc.Traversableimportlib.resources.abc.TraversableResources
(Contributed by Jason R. Coombs and Hugo van Kemenade in
93963.) -
itertools: Deprecate the support for copy, deepcopy, and pickle operations, which is undocumented, inefficient, historically buggy, and inconsistent. This will be removed in 3.14 for a significant reduction in code volume and maintenance burden. (Contributed by Raymond Hettinger in101588.) -
multiprocessing: In Python 3.14, the defaultmultiprocessingstart method will change to a safer one on Linux, BSDs, and other non-macOS POSIX platforms where'fork'is currently the default (84559). Adding a runtime warning about this was deemed too disruptive as the majority of code is not expected to care. Use the~multiprocessing.get_contextor~multiprocessing.set_start_methodAPIs to explicitly specify when your code requires'fork'. Seecontexts and start methods <multiprocessing-start-methods>. -
pkgutil:!pkgutil.find_loaderand!pkgutil.get_loaderare deprecated and will be removed in Python 3.14; useimportlib.util.find_specinstead. (Contributed by Nikita Sobolev in97850.) -
pty: The module has two undocumentedmaster_open()andslave_open()functions that have been deprecated since Python 2 but only gained a properDeprecationWarningin 3.12. Remove them in 3.14. (Contributed by Soumendra Ganguly and Gregory P. Smith in85984.) -
os:- The
st_ctimefields return byos.statandos.lstaton Windows are deprecated. In a future release, they will contain the last metadata change time, consistent with other platforms. For now, they still contain the creation time, which is also available in the newst_birthtimefield. (Contributed by Steve Dower in99726.) - On POSIX platforms,
os.forkcan now raise aDeprecationWarningwhen it can detect being called from a multithreaded process. There has always been a fundamental incompatibility with the POSIX platform when doing so. Even if such code appeared to work. We added the warning to raise awareness as issues encountered by code doing this are becoming more frequent. See theos.forkdocumentation for more details along with this discussion on fork being incompatible with threads for why we're now surfacing this longstanding platform compatibility problem to developers.
When this warning appears due to usage of
multiprocessingorconcurrent.futuresthe fix is to use a differentmultiprocessingstart method such as"spawn"or"forkserver". - The
-
shutil: The onerror argument ofshutil.rmtreeis deprecated; use onexc instead. (Contributed by Irit Katriel in102828.) -
sqlite3:default adapters and converters <sqlite3-default-converters>are now deprecated. Instead, use thesqlite3-adapter-converter-recipesand tailor them to your needs. (Contributed by Erlend E. Aasland in90016.)- In
~sqlite3.Cursor.execute,DeprecationWarningis now emitted whennamed placeholders <sqlite3-placeholders>are used together with parameters supplied as asequenceinstead of as adict. Starting from Python 3.14, using named placeholders with parameters supplied as a sequence will raise a~sqlite3.ProgrammingError. (Contributed by Erlend E. Aasland in101698.)
-
sys: Thesys.last_type,sys.last_valueandsys.last_tracebackfields are deprecated. Usesys.last_excinstead. (Contributed by Irit Katriel in102778.) -
tarfile: Extracting tar archives without specifying filter is deprecated until Python 3.14, when'data'filter will become the default. Seetarfile-extraction-filterfor details. -
typing:typing.Hashableandtyping.Sized, aliases forcollections.abc.Hashableandcollections.abc.Sizedrespectively, are deprecated. (94309.)typing.ByteString, deprecated since Python 3.9, now causes aDeprecationWarningto be emitted when it is used. (Contributed by Alex Waygood in91896.)
-
xml.etree.ElementTree: The module now emitsDeprecationWarningwhen testing the truth value of anxml.etree.ElementTree.Element. Before, the Python implementation emittedFutureWarning, and the C implementation emitted nothing. (Contributed by Jacob Walls in83122.) -
The 3-arg signatures (type, value, traceback) of
coroutine throw() <coroutine.throw>,generator throw() <generator.throw>andasync generator throw() <agen.athrow>are deprecated and may be removed in a future version of Python. Use the single-arg versions of these functions instead. (Contributed by Ofey Chan in89874.) -
DeprecationWarningis now raised when~module.__package__on a module differs from__spec__.parent <importlib.machinery.ModuleSpec.parent>(previously it wasImportWarning). (Contributed by Brett Cannon in65961.) -
Setting
~module.__package__or__cached__on a module is deprecated, and will cease to be set or taken into consideration by the import system in Python 3.14. (Contributed by Brett Cannon in65961.) -
The bitwise inversion operator (
~) on bool is deprecated. It will throw an error in Python 3.16. Usenotfor logical negation of bools instead. In the rare case that you really need the bitwise inversion of the underlyingint, convert to int explicitly:~int(x). (Contributed by Tim Hoffmann in103487.) -
Accessing
!codeobject.co_lnotabon code objects was deprecated in Python 3.10 via626, but it only got a properDeprecationWarningin 3.12. May be removed in 3.15. (Contributed by Nikita Sobolev in101866.)
Pending removal in Python 3.13
Modules (see 594):
!aifc!audioop!cgi!cgitb!chunk!crypt!imghdr!mailcap!msilib!nis!nntplib!ossaudiodev!pipes!sndhdr!spwd!sunau!telnetlib!uu!xdrlib
Other modules:
!lib2to3, and the2to3program (84540)
APIs:
!configparser.LegacyInterpolation(90765)locale.resetlocale()(90817)!turtle.RawTurtle.settiltangle(50096)!unittest.findTestCases(50096)!unittest.getTestCaseNames(50096)!unittest.makeSuite(50096)!unittest.TestProgram.usageExit(67048)!webbrowser.MacOSX(86421)classmethoddescriptor chaining (89519)
Pending removal in Python 3.14
-
argparse: The type, choices, and metavar parameters of!argparse.BooleanOptionalActionare deprecated and will be removed in 3.14. (Contributed by Nikita Sobolev in92248.) -
ast: The following features have been deprecated in documentation since Python 3.8, now cause aDeprecationWarningto be emitted at runtime when they are accessed or used, and will be removed in Python 3.14:!ast.Num!ast.Str!ast.Bytes!ast.NameConstant!ast.Ellipsis
Use
ast.Constantinstead. (Contributed by Serhiy Storchaka in90953.) -
asyncio:- The child watcher classes
!asyncio.MultiLoopChildWatcher,!asyncio.FastChildWatcher,!asyncio.AbstractChildWatcherand!asyncio.SafeChildWatcherare deprecated and will be removed in Python 3.14. (Contributed by Kumar Aditya in94597.) !asyncio.set_child_watcher,!asyncio.get_child_watcher,!asyncio.AbstractEventLoopPolicy.set_child_watcherand!asyncio.AbstractEventLoopPolicy.get_child_watcherare deprecated and will be removed in Python 3.14. (Contributed by Kumar Aditya in94597.)- The
~asyncio.get_event_loopmethod of the default event loop policy now emits aDeprecationWarningif there is no current event loop set and it decides to create one. (Contributed by Serhiy Storchaka and Guido van Rossum in100160.)
- The child watcher classes
-
email: Deprecated the isdst parameter inemail.utils.localtime. (Contributed by Alan Williams in72346.) -
importlib.abcdeprecated classes:!importlib.abc.ResourceReader!importlib.abc.Traversable!importlib.abc.TraversableResources
Use
importlib.resources.abcclasses instead:importlib.resources.abc.Traversableimportlib.resources.abc.TraversableResources
(Contributed by Jason R. Coombs and Hugo van Kemenade in
93963.) -
itertoolshad undocumented, inefficient, historically buggy, and inconsistent support for copy, deepcopy, and pickle operations. This will be removed in 3.14 for a significant reduction in code volume and maintenance burden. (Contributed by Raymond Hettinger in101588.) -
multiprocessing: The default start method will change to a safer one on Linux, BSDs, and other non-macOS POSIX platforms where'fork'is currently the default (84559). Adding a runtime warning about this was deemed too disruptive as the majority of code is not expected to care. Use the~multiprocessing.get_contextor~multiprocessing.set_start_methodAPIs to explicitly specify when your code requires'fork'. Seemultiprocessing-start-methods. -
pathlib:~pathlib.PurePath.is_relative_toand~pathlib.PurePath.relative_to: passing additional arguments is deprecated. -
pkgutil:!pkgutil.find_loaderand!pkgutil.get_loadernow raiseDeprecationWarning; useimportlib.util.find_specinstead. (Contributed by Nikita Sobolev in97850.) -
pty:master_open(): usepty.openpty.slave_open(): usepty.openpty.
-
sqlite3:!versionand!version_info.~sqlite3.Cursor.executeand~sqlite3.Cursor.executemanyifnamed placeholders <sqlite3-placeholders>are used and parameters is a sequence instead of adict.
-
urllib:!urllib.parse.Quoteris deprecated: it was not intended to be a public API. (Contributed by Gregory P. Smith in88168.)
Pending removal in Python 3.15
- The import system:
- Setting
__cached__on a module while failing to set__spec__.cached <importlib.machinery.ModuleSpec.cached>is deprecated. In Python 3.15,__cached__will cease to be set or take into consideration by the import system or standard library. (97879)
- Setting
ctypes:- The undocumented
!ctypes.SetPointerTypefunction has been deprecated since Python 3.13.
- The undocumented
http.server:- The obsolete and rarely used
!CGIHTTPRequestHandlerhas been deprecated since Python 3.13. No direct replacement exists. Anything is better than CGI to interface a web server with a request handler. - The
!--cgiflag to thepython -m http.servercommand-line interface has been deprecated since Python 3.13.
- The obsolete and rarely used
importlib:load_module()method: useexec_module()instead.
pathlib:!.PurePath.is_reservedhas been deprecated since Python 3.13. Useos.path.isreservedto detect reserved paths on Windows.
platform:!platform.java_verhas been deprecated since Python 3.13. This function is only useful for Jython support, has a confusing API, and is largely untested.
sysconfig:- The check_home argument of
sysconfig.is_python_buildhas been deprecated since Python 3.12.
- The check_home argument of
threading:~threading.RLockwill take no arguments in Python 3.15. Passing any arguments has been deprecated since Python 3.14, as the Python version does not permit any arguments, but the C version allows any number of positional or keyword arguments, ignoring every argument.
types:types.CodeType: Accessing!codeobject.co_lnotabwas deprecated in626since 3.10 and was planned to be removed in 3.12, but it only got a properDeprecationWarningin 3.12. May be removed in 3.15. (Contributed by Nikita Sobolev in101866.)
typing:- The undocumented keyword argument syntax for creating
~typing.NamedTupleclasses (for example,Point = NamedTuple("Point", x=int, y=int)) has been deprecated since Python 3.13. Use the class-based syntax or the functional syntax instead. - When using the functional syntax of
~typing.TypedDicts, failing to pass a value to the fields parameter (TD = TypedDict("TD")) or passingNone(TD = TypedDict("TD", None)) has been deprecated since Python 3.13. Useclass TD(TypedDict): passorTD = TypedDict("TD", {})to create a TypedDict with zero field. - The
!typing.no_type_check_decoratordecorator function has been deprecated since Python 3.13. After eight years in thetypingmodule, it has yet to be supported by any major type checker.
- The undocumented keyword argument syntax for creating
!sre_compile,!sre_constantsand!sre_parsemodules.wave:- The
getmark(),setmark()andgetmarkers()methods of the~wave.Wave_readand~wave.Wave_writeclasses have been deprecated since Python 3.13.
- The
zipimport:!zipimport.zipimporter.load_modulehas been deprecated since Python 3.10. Use~zipimport.zipimporter.exec_moduleinstead. (125746.)
Pending removal in Python 3.16
- The import system:
- Setting
~module.__loader__on a module while failing to set__spec__.loader <importlib.machinery.ModuleSpec.loader>is deprecated. In Python 3.16,!__loader__will cease to be set or taken into consideration by the import system or the standard library. - Setting
~module.__package__on a module while failing to set__spec__.parent <importlib.machinery.ModuleSpec.parent>is deprecated. In Python 3.16,!__package__will cease to be taken into consideration by the import system or standard library. (97879)
- Setting
- The bundled copy of
libmpdec. array:- The
'u'format code (wchar_t) has been deprecated in documentation since Python 3.3 and at runtime since Python 3.13. Use the'w'format code (Py_UCS4) for Unicode characters instead.
- The
asyncio:-
!asyncio.iscoroutinefunctionis deprecated and will be removed in Python 3.16; useinspect.iscoroutinefunctioninstead. (Contributed by Jiahao Li and Kumar Aditya in122875.) -
asynciopolicy system is deprecated and will be removed in Python 3.16. In particular, the following classes and functions are deprecated:!asyncio.AbstractEventLoopPolicy!asyncio.DefaultEventLoopPolicy!asyncio.WindowsSelectorEventLoopPolicy!asyncio.WindowsProactorEventLoopPolicy!asyncio.get_event_loop_policy!asyncio.set_event_loop_policy
Users should use
asyncio.runorasyncio.Runnerwith loop_factory to use the desired event loop implementation.For example, to use
asyncio.SelectorEventLoopon Windows:import asyncio async def main(): ... asyncio.run(main(), loop_factory=asyncio.SelectorEventLoop)(Contributed by Kumar Aditya in
127949.)
-
builtins:- Bitwise inversion on boolean types,
~Trueor~Falsehas been deprecated since Python 3.12, as it produces surprising and unintuitive results (-2and-1). Usenot xinstead for the logical negation of a Boolean. In the rare case that you need the bitwise inversion of the underlying integer, convert tointexplicitly (~int(x)).
- Bitwise inversion on boolean types,
functools:- Calling the Python implementation of
functools.reducewith function or sequence as keyword arguments has been deprecated since Python 3.14.
- Calling the Python implementation of
logging:- Support for custom logging handlers with the strm argument is deprecated and scheduled for removal in Python 3.16. Define handlers with the stream argument instead. (Contributed by Mariusz Felisiak in
115032.)
- Support for custom logging handlers with the strm argument is deprecated and scheduled for removal in Python 3.16. Define handlers with the stream argument instead. (Contributed by Mariusz Felisiak in
mimetypes:- Valid extensions start with a '.' or are empty for
mimetypes.MimeTypes.add_type. Undotted extensions are deprecated and will raise aValueErrorin Python 3.16. (Contributed by Hugo van Kemenade in75223.)
- Valid extensions start with a '.' or are empty for
shutil:- The
!ExecErrorexception has been deprecated since Python 3.14. It has not been used by any function in!shutilsince Python 3.4, and is now an alias ofRuntimeError.
- The
symtable:- The
!symtable.Class.get_methodsmethod has been deprecated since Python 3.14.
- The
sys:- The
!_enablelegacywindowsfsencodingfunction has been deprecated since Python 3.13. Use thePYTHONLEGACYWINDOWSFSENCODINGenvironment variable instead.
- The
sysconfig:- The
!sysconfig.expand_makefile_varsfunction has been deprecated since Python 3.14. Use thevarsargument ofsysconfig.get_pathsinstead.
- The
tarfile:- The undocumented and unused
!TarInfo.tarfileattribute has been deprecated since Python 3.13.
- The undocumented and unused
Pending removal in Python 3.17
datetime:~datetime.datetime.strptimecalls using a format string containing%e(day of month) without a year. This has been deprecated since Python 3.15. (Contributed by Stan Ulbrych in70647.)
collections.abc:-
collections.abc.ByteStringis scheduled for removal in Python 3.17.Use
isinstance(obj, collections.abc.Buffer)to test ifobjimplements thebuffer protocol <bufferobjects>at runtime. For use in type annotations, either use~collections.abc.Bufferor a union that explicitly specifies the types your code supports (e.g.,bytes | bytearray | memoryview).!ByteStringwas originally intended to be an abstract class that would serve as a supertype of bothbytesandbytearray. However, since the ABC never had any methods, knowing that an object was an instance of!ByteStringnever actually told you anything useful about the object. Other common buffer types such asmemoryviewwere also never understood as subtypes of!ByteString(either at runtime or by static type checkers).See
PEP 688 <688#current-options>for more details. (Contributed by Shantanu Jain in91896.)
-
encodings:- Passing non-ascii encoding names to
encodings.normalize_encodingis deprecated and scheduled for removal in Python 3.17. (Contributed by Stan Ulbrych in136702.)
- Passing non-ascii encoding names to
profile:- The
!profilemodule is deprecated and will be removed in Python 3.17. Useprofiling.tracinginstead, which provides a compatible API. See799for details. (Contributed by Pablo Galindo and László Kiss Kollár in138122.)
- The
webbrowser:!webbrowser.MacOSXOSAScriptis deprecated in favour of!webbrowser.MacOS. (137586)
typing:-
Before Python 3.14, old-style unions were implemented using the private class
typing._UnionGenericAlias. This class is no longer needed for the implementation, but it has been retained for backward compatibility, with removal scheduled for Python 3.17. Users should use documented introspection helpers liketyping.get_originandtyping.get_argsinstead of relying on private implementation details. -
typing.ByteString, deprecated since Python 3.9, is scheduled for removal in Python 3.17.Use
isinstance(obj, collections.abc.Buffer)to test ifobjimplements thebuffer protocol <bufferobjects>at runtime. For use in type annotations, either use~collections.abc.Bufferor a union that explicitly specifies the types your code supports (e.g.,bytes | bytearray | memoryview).!ByteStringwas originally intended to be an abstract class that would serve as a supertype of bothbytesandbytearray. However, since the ABC never had any methods, knowing that an object was an instance of!ByteStringnever actually told you anything useful about the object. Other common buffer types such asmemoryviewwere also never understood as subtypes of!ByteString(either at runtime or by static type checkers).See
PEP 688 <688#current-options>for more details. (Contributed by Shantanu Jain in91896.)
-
tkinter:- The
!tkinter.Variablemethods!trace_variable,!trace(an alias of!trace_variable),!trace_vdeleteand!trace_vinfo, deprecated since Python 3.14, are scheduled for removal in Python 3.17. Use!trace_add,!trace_removeand!trace_infoinstead. (Contributed by Serhiy Storchaka in120220.)
- The
Pending removal in Python 3.19
builtins:- Passing a complex number as the real or imag argument in the
complexconstructor is now deprecated; it should only be passed as a single positional argument. (Contributed by Serhiy Storchaka in109218.)
- Passing a complex number as the real or imag argument in the
ctypes:- Implicitly switching to the MSVC-compatible struct layout by setting
~ctypes.Structure._pack_but not~ctypes.Structure._layout_on non-Windows platforms.
- Implicitly switching to the MSVC-compatible struct layout by setting
hashlib:-
In hash function constructors such as
~hashlib.newor the direct hash-named constructors such as~hashlib.md5and~hashlib.sha256, their optional initial data parameter could also be passed a keyword argument nameddata=orstring=in various!hashlibimplementations.Support for the
stringkeyword argument name is now deprecated and slated for removal in Python 3.19.Before Python 3.13, the
stringkeyword parameter was not correctly supported depending on the backend implementation of hash functions. Prefer passing the initial data as a positional argument for maximum backwards compatibility.
-
http.cookies:http.cookies.Morsel.js_outputis deprecated and will be removed in Python 3.19.http.cookies.BaseCookie.js_outputis deprecated and will be removed in Python 3.19.
imaplib:-
Altering
IMAP4.file <imaplib.IMAP4.file>is now deprecated and slated for removal in Python 3.19. This property is now unused and changing its value does not automatically close the current file.Before Python 3.14, this property was used to implement the corresponding
read()andreadline()methods for~imaplib.IMAP4but this is no longer the case since then.
-
tkinter:tkinter.filedialog.askopenfileshas been deprecated since Python 3.16. Iterate over the names returned by~tkinter.filedialog.askopenfilenamesand open them one by one instead. (Contributed by Serhiy Storchaka in152638.)
Pending removal in Python 3.20
-
Calling the
__new__()method ofstruct.Structwithout the format argument is deprecated and will be removed in Python 3.20. Calling~object.__init__method on initialized~struct.Structobjects is deprecated and will be removed in Python 3.20.(Contributed by Sergey B Kirpichev and Serhiy Storchaka in
143715.) -
The
__version__,versionandVERSIONattributes have been deprecated in these standard library modules and will be removed in Python 3.20. Usesys.version_infoinstead.argparsecsvctypes!ctypes.macholibdecimal(usedecimal.SPEC_VERSIONinstead)http.serverimaplibipaddressjsonlogging(__date__also deprecated)optparsepickleplatformresocketservertabnannytarfiletkinter.fonttkinter.ttkwsgiref.simple_serverxml.etree.ElementTree!xml.sax.expatreaderxml.sax.handlerzlib
(Contributed by Hugo van Kemenade and Stan Ulbrych in
76007.) -
The
__author__,__credits__,__copyright__and__date__attributes have been deprecated in these standard library modules and will be removed in Python 3.20. Attribution is preserved in the source code and the version control history.bz2concurrent.futuresinspectiojsonloggingoptparseplatformpydoctarfiletkinter.ttktokenizeuuid
(Contributed by Stan Ulbrych in
159240.) -
Deprecations defined by
829:- Warnings are produced for
importlines found in{name}.pthfiles. {name}.pthfiles are no longer decoded in the locale encoding by default. They MUST be encoded inutf-8-sig.
(Contributed by Barry Warsaw in
148641.) - Warnings are produced for
-
ast:- Creating instances of abstract AST nodes (such as
ast.ASTor!ast.expr) is deprecated and will raise an error in Python 3.20.
- Creating instances of abstract AST nodes (such as
-
typing:-
It is deprecated to call
isinstanceandissubclasschecks on protocol classes that were not explicitly decorated with!runtime_checkablebut that inherit from a runtime-checkable protocol class. This will raise aTypeErrorin Python 3.20.(Contributed by Bartosz Sławecki in
132604.)
-
Pending removal in Python 3.21
-
abc- Soft-deprecated since Python 3.3
abc.abstractclassmethod,abc.abstractstaticmethod, andabc.abstractpropertynow raise aDeprecationWarning. These classes will be removed in Python 3.21, instead useabc.abstractmethodwithclassmethod,staticmethod, andpropertyrespectively.
- Soft-deprecated since Python 3.3
-
ast:- Classes
slice,Index,ExtSlice,Suite,Param,AugLoadandAugStore, will be removed in Python 3.21. These types are not generated by the parser or accepted by the code generator. - The
dimsproperty ofast.Tuplewill be removed in Python 3.21. Use theast.Tuple.eltsproperty instead.
- Classes
-
functools:- Using a return annotation to infer the dispatch type for
functools.singledispatchorfunctools.singledispatchmethodis deprecated since Python 3.16 and will raiseTypeErrorin Python 3.21. Annotate the dispatch parameter or pass the dispatch type explicitly instead. (Contributed by Bartosz Sławecki in143465.)
- Using a return annotation to infer the dispatch type for
-
struct:- Soft-deprecated since Python 3.15, using
'F'and'D'type codes are now deprecated. These codes will be removed in Python 3.21. Use instead two-letter forms'Zf'and'Zd'.
- Soft-deprecated since Python 3.15, using
-
tempfile:tempfile._TemporaryFileWrapperwill be removed in Python 3.21. Use the publictempfile.TemporaryFileWrapperinstead.
Pending removal in future versions
The following APIs will be removed in the future, although there is currently no date scheduled for their removal.
argparse:- Nesting argument groups and nesting mutually exclusive groups are deprecated.
- Passing the undocumented keyword argument prefix_chars to
~argparse.ArgumentParser.add_argument_groupis now deprecated. - The
argparse.FileTypetype converter is deprecated.
builtins:- Generators:
throw(type, exc, tb)andathrow(type, exc, tb)signature is deprecated: usethrow(exc)andathrow(exc)instead, the single argument signature. - 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]). A syntax warning is raised if the numeric literal is immediately followed by one of keywordsand,else,for,if,in,isandor. In a future release it will be changed to a syntax error. (87999) - Support for
__index__()and__int__()method returning non-int type: these methods will be required to return an instance of a strict subclass ofint. - Support for
__float__()method returning a strict subclass offloat: these methods will be required to return an instance offloat. - Support for
__complex__()method returning a strict subclass ofcomplex: these methods will be required to return an instance ofcomplex.
- Generators:
calendar:calendar.Januaryandcalendar.Februaryconstants are deprecated and replaced bycalendar.JANUARYandcalendar.FEBRUARY. (Contributed by Prince Roshan in103636.)codecs: useopeninstead ofcodecs.open. (133038)!codeobject.co_lnotab: use thecodeobject.co_linesmethod instead.datetime:~datetime.datetime.utcnow: usedatetime.datetime.now(tz=datetime.UTC).~datetime.datetime.utcfromtimestamp: usedatetime.datetime.fromtimestamp(timestamp, tz=datetime.UTC).
gettext: Plural value must be an integer.importlib:~importlib.util.cache_from_sourcedebug_override parameter is deprecated: use the optimization parameter instead.
importlib.metadata:EntryPointstuple interface.- Implicit
Noneon return values.
logging: thewarn()method has been deprecated since Python 3.3, use~logging.warninginstead.mailbox: Use of StringIO input and text mode is deprecated, use BytesIO and binary mode instead.os: Callingos.register_at_forkin a multi-threaded process.os.path:os.path.commonprefixis deprecated, useos.path.commonpathfor path prefixes. Theos.path.commonprefixfunction is being deprecated due to having a misleading name and module. The function is not safe to use for path prefixes despite being included in a module about path manipulation, meaning it is easy to accidentally introduce path traversal vulnerabilities into Python programs by using this function.!pydoc.ErrorDuringImport: A tuple value for exc_info parameter is deprecated, use an exception instance.re: More strict rules are now applied for numerical group references and group names in regular expressions. Only sequence of ASCII digits is now accepted as a numerical reference. The group name in bytes patterns and replacement strings can now only contain ASCII letters and digits and underscore. (Contributed by Serhiy Storchaka in91760.)shutil:~shutil.rmtree's onerror parameter is deprecated in Python 3.12; use the onexc parameter instead.ssloptions and protocols:ssl.SSLContextwithout protocol argument is deprecated.ssl.SSLContext:~ssl.SSLContext.set_npn_protocolsand!selected_npn_protocolare deprecated: use ALPN instead.ssl.OP_NO_SSL*optionsssl.OP_NO_TLS*optionsssl.PROTOCOL_SSLv3ssl.PROTOCOL_TLSssl.PROTOCOL_TLSv1ssl.PROTOCOL_TLSv1_1ssl.PROTOCOL_TLSv1_2ssl.TLSVersion.SSLv3ssl.TLSVersion.TLSv1ssl.TLSVersion.TLSv1_1
threadingmethods:!threading.Condition.notifyAll: use~threading.Condition.notify_all.!threading.Event.isSet: use~threading.Event.is_set.!threading.Thread.isDaemon,threading.Thread.setDaemon: usethreading.Thread.daemonattribute.!threading.Thread.getName,threading.Thread.setName: usethreading.Thread.nameattribute.!threading.currentThread: usethreading.current_thread.!threading.activeCount: usethreading.active_count.
typing.Text(92332).- The internal class
typing._UnionGenericAliasis no longer used to implementtyping.Union. To preserve compatibility with users using this private class, a compatibility shim will be provided until at least Python 3.17. (Contributed by Jelle Zijlstra in105499.) unittest.IsolatedAsyncioTestCase: it is deprecated to return a value that is notNonefrom a test case.urllib.parsedeprecated functions:~urllib.parse.urlparseinsteadsplitattr()splithost()splitnport()splitpasswd()splitport()splitquery()splittag()splittype()splituser()splitvalue()to_bytes()
wsgiref:SimpleHandler.stdout.write()should not do partial writes.xml.etree.ElementTree: Testing the truth value of an~xml.etree.ElementTree.Elementis deprecated. In a future release it will always returnTrue. Prefer explicitlen(elem)orelem is not Nonetests instead.sys._clear_type_cacheis deprecated: usesys._clear_internal_cachesinstead.
Removed
asynchat and asyncore
- These two modules have been removed according to the schedule in
594, having been deprecated in Python 3.6. Useasyncioinstead. (Contributed by Nikita Sobolev in96580.)
configparser
- Several names deprecated in the
configparserway back in 3.2 have been removed per89336:configparser.ParsingErrorno longer has afilenameattribute or argument. Use thesourceattribute and argument instead.configparserno longer has aSafeConfigParserclass. Use the shorter~configparser.ConfigParsername instead.configparser.ConfigParserno longer has areadfpmethod. Use~configparser.ConfigParser.read_fileinstead.
distutils
- Remove the
!distutilspackage. It was deprecated in Python 3.10 by632"Deprecate distutils module". For projects still usingdistutilsand cannot be updated to something else, thesetuptoolsproject can be installed: it still providesdistutils. (Contributed by Victor Stinner in92584.)
ensurepip
-
Remove the bundled setuptools wheel from
ensurepip, and stop installing setuptools in environments created byvenv.pip (>= 22.1)does not require setuptools to be installed in the environment.setuptools-based (anddistutils-based) packages can still be used withpip install, since pip will providesetuptoolsin the build environment it uses for building a package.easy_install,pkg_resources,setuptoolsanddistutilsare no longer provided by default in environments created withvenvor bootstrapped withensurepip, since they are part of thesetuptoolspackage. For projects relying on these at runtime, thesetuptoolsproject should be declared as a dependency and installed separately (typically, using pip).(Contributed by Pradyun Gedam in
95299.)
enum
- Remove
enum'sEnumMeta.__getattr__, which is no longer needed for enum attribute access. (Contributed by Ethan Furman in95083.)
ftplib
- Remove
ftplib'sFTP_TLS.ssl_versionclass attribute: use the context parameter instead. (Contributed by Victor Stinner in94172.)
gzip
- Remove the
filenameattribute ofgzip'sgzip.GzipFile, deprecated since Python 2.6, use the~gzip.GzipFile.nameattribute instead. In write mode, thefilenameattribute added'.gz'file extension if it was not present. (Contributed by Victor Stinner in94196.)
hashlib
- Remove the pure Python implementation of
hashlib'shashlib.pbkdf2_hmac, deprecated in Python 3.10. Python 3.10 and newer requires OpenSSL 1.1.1 (644): this OpenSSL version provides a C implementation of~hashlib.pbkdf2_hmacwhich is faster. (Contributed by Victor Stinner in94199.)
importlib
- Many previously deprecated cleanups in
importlibhave now been completed:- References to, and support for
!module_reprhas been removed. (Contributed by Barry Warsaw in97850.) importlib.util.set_package,importlib.util.set_loaderandimportlib.util.module_for_loaderhave all been removed. (Contributed by Brett Cannon and Nikita Sobolev in65961and97850.)- Support for
find_loader()andfind_module()APIs have been removed. (Contributed by Barry Warsaw in98040.) importlib.abc.Finder,pkgutil.ImpImporter, andpkgutil.ImpLoaderhave been removed. (Contributed by Barry Warsaw in98040.)
- References to, and support for
imp
-
The
!impmodule has been removed. (Contributed by Barry Warsaw in98040.)To migrate, consult the following correspondence table:
imp importlib imp.NullImporterInsert Noneintosys.path_importer_cacheimp.cache_from_source()importlib.util.cache_from_sourceimp.find_module()importlib.util.find_specimp.get_magic()importlib.util.MAGIC_NUMBERimp.get_suffixes()importlib.machinery.SOURCE_SUFFIXES,importlib.machinery.EXTENSION_SUFFIXES, andimportlib.machinery.BYTECODE_SUFFIXESimp.get_tag()sys.implementation.cache_tag <sys.implementation>imp.load_module()importlib.import_moduleimp.new_module(name)types.ModuleType(name)imp.reload()importlib.reloadimp.source_from_cache()importlib.util.source_from_cacheimp.load_source()See below Replace
imp.load_source()with:import importlib.util import importlib.machinery def load_source(modname, filename): loader = importlib.machinery.SourceFileLoader(modname, filename) spec = importlib.util.spec_from_file_location(modname, filename, loader=loader) module = importlib.util.module_from_spec(spec) # The module is always executed and not cached in sys.modules. # Uncomment the following line to cache the module. # sys.modules[module.__name__] = module loader.exec_module(module) return module -
Remove
!impfunctions and attributes with no replacements:- Undocumented functions:
imp.init_builtin()imp.load_compiled()imp.load_dynamic()imp.load_package()
imp.lock_held(),imp.acquire_lock(),imp.release_lock(): the locking scheme has changed in Python 3.3 to per-module locks.imp.find_module()constants:SEARCH_ERROR,PY_SOURCE,PY_COMPILED,C_EXTENSION,PY_RESOURCE,PKG_DIRECTORY,C_BUILTIN,PY_FROZEN,PY_CODERESOURCE,IMP_HOOK.
- Undocumented functions:
io
- Remove
io'sio.OpenWrapperand_pyio.OpenWrapper, deprecated in Python 3.10: just useopeninstead. Theopen(io.open) function is a built-in function. Since Python 3.10,!_pyio.openis also a static method. (Contributed by Victor Stinner in94169.)
locale
- Remove
locale's!locale.formatfunction, deprecated in Python 3.7: uselocale.format_stringinstead. (Contributed by Victor Stinner in94226.)
smtpd
- The
smtpdmodule has been removed according to the schedule in594, having been deprecated in Python 3.4.7 and 3.5.4. Use theaiosmtpdPyPI module or any otherasyncio-based server instead. (Contributed by Oleg Iarygin in93243.)
sqlite3
-
The following undocumented
sqlite3features, deprecated in Python 3.10, are now removed:sqlite3.enable_shared_cache()sqlite3.OptimizedUnicode
If a shared cache must be used, open the database in URI mode using the
cache=sharedquery parameter.The
sqlite3.OptimizedUnicodetext factory has been an alias forstrsince Python 3.3. Code that previously set the text factory toOptimizedUnicodecan either usestrexplicitly, or rely on the default value which is alsostr.(Contributed by Erlend E. Aasland in
92548.)
ssl
- Remove
ssl's!ssl.RAND_pseudo_bytesfunction, deprecated in Python 3.6: useos.urandomorssl.RAND_bytesinstead. (Contributed by Victor Stinner in94199.) - Remove the
!ssl.match_hostnamefunction. It was deprecated in Python 3.7. OpenSSL performs hostname matching since Python 3.7, Python no longer uses the!ssl.match_hostnamefunction. (Contributed by Victor Stinner in94199.) - Remove the
!ssl.wrap_socketfunction, deprecated in Python 3.7: instead, create assl.SSLContextobject and call itsssl.SSLContext.wrap_socketmethod. Any package that still uses!ssl.wrap_socketis broken and insecure. The function neither sends a SNI TLS extension nor validates the server hostname. Code is subject to295(Improper Certificate Validation). (Contributed by Victor Stinner in94199.)
unittest
-
Remove many long-deprecated
unittestfeatures:-
A number of
~unittest.TestCasemethod aliases:Deprecated alias Method Name Deprecated in failUnless.assertTrue3.1 failIf.assertFalse3.1 failUnlessEqual.assertEqual3.1 failIfEqual.assertNotEqual3.1 failUnlessAlmostEqual.assertAlmostEqual3.1 failIfAlmostEqual.assertNotAlmostEqual3.1 failUnlessRaises.assertRaises3.1 assert_.assertTrue3.2 assertEquals.assertEqual3.2 assertNotEquals.assertNotEqual3.2 assertAlmostEquals.assertAlmostEqual3.2 assertNotAlmostEquals.assertNotAlmostEqual3.2 assertRegexpMatches.assertRegex3.2 assertRaisesRegexp.assertRaisesRegex3.2 assertNotRegexpMatches.assertNotRegex3.5 You can use https://github.com/isidentical/teyit to automatically modernise your unit tests.
-
Undocumented and broken
~unittest.TestCasemethodassertDictContainsSubset(deprecated in Python 3.2). -
Undocumented
TestLoader.loadTestsFromModule <unittest.TestLoader.loadTestsFromModule>parameter use_load_tests (deprecated and ignored since Python 3.5). -
An alias of the
~unittest.TextTestResultclass:_TextTestResult(deprecated in Python 3.2).
(Contributed by Serhiy Storchaka in
89325.) -
webbrowser
- Remove support for obsolete browsers from
webbrowser. The removed browsers include: Grail, Mosaic, Netscape, Galeon, Skipstone, Iceape, Firebird, and Firefox versions 35 and below (102871).
xml.etree.ElementTree
- Remove the
ElementTree.Element.copy()method of the pure Python implementation, deprecated in Python 3.10, use thecopy.copyfunction instead. The C implementation ofxml.etree.ElementTreehas nocopy()method, only a__copy__()method. (Contributed by Victor Stinner in94383.)
zipimport
- Remove
zipimport'sfind_loader()andfind_module()methods, deprecated in Python 3.10: use thefind_spec()method instead. See451for the rationale. (Contributed by Victor Stinner in94379.)
Others
- Remove the
suspiciousrule from the documentationMakefileandDoc/tools/rstlint.py, both in favor of sphinx-lint. (Contributed by Julien Palard in98179.) - Remove the keyfile and certfile parameters from the
ftplib,imaplib,poplibandsmtplibmodules, and the key_file, cert_file and check_hostname parameters from thehttp.clientmodule, all deprecated since Python 3.6. Use the context parameter (ssl_context inimaplib) instead. (Contributed by Victor Stinner in94172.) - Remove
Jythoncompatibility hacks from several stdlib modules and tests. (Contributed by Nikita Sobolev in99482.) - Remove
_use_broken_old_ctypes_structure_semantics_flag fromctypesmodule. (Contributed by Nikita Sobolev in99285.)
Porting to Python 3.12
This section lists previously described changes and other bugfixes that may require changes to your code.
Changes in the Python API
-
More strict rules are now applied for numerical group references and group names in regular expressions. Only sequence of ASCII digits is now accepted as a numerical reference. The group name in bytes patterns and replacement strings can now only contain ASCII letters and digits and underscore. (Contributed by Serhiy Storchaka in
91760.) -
Remove
randrange()functionality deprecated since Python 3.10. Formerly,randrange(10.0)losslessly converted torandrange(10). Now, it raises aTypeError. Also, the exception raised for non-integer values such asrandrange(10.5)orrandrange('10')has been changed fromValueErrortoTypeError. This also prevents bugs whererandrange(1e25)would silently select from a larger range thanrandrange(10**25). (Originally suggested by Serhiy Storchaka86388.) -
argparse.ArgumentParserchanged encoding and error handler for reading arguments from file (e.g.fromfile_prefix_charsoption) from default text encoding (e.g.locale.getpreferredencoding(False) <locale.getpreferredencoding>) tofilesystem encoding and error handler. Argument files should be encoded in UTF-8 instead of ANSI Codepage on Windows. -
Remove the
asyncore-basedsmtpdmodule deprecated in Python 3.4.7 and 3.5.4. A recommended replacement is theasyncio-basedaiosmtpdPyPI module. -
shlex.split: PassingNonefor s argument now raises an exception, rather than readingsys.stdin. The feature was deprecated in Python 3.9. (Contributed by Victor Stinner in94352.) -
The
osmodule no longer accepts bytes-like paths, likebytearrayandmemoryviewtypes: only the exactbytestype is accepted for bytes strings. (Contributed by Victor Stinner in98393.) -
syslog.openlogandsyslog.closelognow fail if used in subinterpreters.syslog.syslogmay still be used in subinterpreters, but now only ifsyslog.openloghas already been called in the main interpreter. These new restrictions do not apply to the main interpreter, so only a very small set of users might be affected. This change helps with interpreter isolation. Furthermore,syslogis a wrapper around process-global resources, which are best managed from the main interpreter. (Contributed by Donghee Na in99127.) -
The undocumented locking behavior of
~functools.cached_propertyis removed, because it locked across all instances of the class, leading to high lock contention. This means that a cached property getter function could now run more than once for a single instance, if two threads race. For most simple cached properties (e.g. those that are idempotent and simply calculate a value based on other attributes of the instance) this will be fine. If synchronization is needed, implement locking within the cached property getter function or around multi-threaded access points. -
sys._current_exceptionsnow returns a mapping from thread-id to an exception instance, rather than to a(typ, exc, tb)tuple. (Contributed by Irit Katriel in103176.) -
When extracting tar files using
tarfileorshutil.unpack_archive, pass the filter argument to limit features that may be surprising or dangerous. Seetarfile-extraction-filterfor details. -
The output of the
tokenize.tokenizeandtokenize.generate_tokensfunctions is now changed due to the changes introduced in701. This means thatSTRINGtokens are not emitted any more for f-strings and the tokens described in701are now produced instead:FSTRING_START,FSTRING_MIDDLEandFSTRING_ENDare now emitted for f-string "string" parts in addition to the appropriate tokens for the tokenization in the expression components. For example for the f-stringf"start {1+1} end"the old version of the tokenizer emitted:1,0-1,18: STRING 'f"start {1+1} end"'while the new version emits:
1,0-1,2: FSTRING_START 'f"' 1,2-1,8: FSTRING_MIDDLE 'start ' 1,8-1,9: OP '{' 1,9-1,10: NUMBER '1' 1,10-1,11: OP '+' 1,11-1,12: NUMBER '1' 1,12-1,13: OP '}' 1,13-1,17: FSTRING_MIDDLE ' end' 1,17-1,18: FSTRING_END '"'Additionally, there may be some minor behavioral changes as a consequence of the changes required to support
701. Some of these changes include:- The
typeattribute of the tokens emitted when tokenizing some invalid Python characters such as!has changed fromERRORTOKENtoOP. - Incomplete single-line strings now also raise
tokenize.TokenErroras incomplete multiline strings do. - Some incomplete or invalid Python code now raises
tokenize.TokenErrorinstead of returning arbitraryERRORTOKENtokens when tokenizing it. - Mixing tabs and spaces as indentation in the same file is not supported anymore and will raise a
TabError.
- The
-
The
threadingmodule now expects the!_threadmodule to have an_is_main_interpreterattribute. It is a function with no arguments that returnsTrueif the current interpreter is the main interpreter.Any library or application that provides a custom
_threadmodule should provide_is_main_interpreter(). (See112826.)
Build Changes
-
Python no longer uses
setup.pyto build shared C extension modules. Build parameters like headers and libraries are detected inconfigurescript. Extensions are built byMakefile. Most extensions usepkg-configand fall back to manual detection. (Contributed by Christian Heimes in93939.) -
va_start()with two parameters, likeva_start(args, format),is now required to build Python.va_start()is no longer called with a single parameter. (Contributed by Kumar Aditya in93207.) -
CPython now uses the ThinLTO option as the default link time optimization policy if the Clang compiler accepts the flag. (Contributed by Donghee Na in
89536.) -
Add
COMPILEALL_OPTSvariable inMakefileto overridecompilealloptions (default:-j0) inmake install. Also merged the 3compileallcommands into a single command to build .pyc files for all optimization levels (0, 1, 2) at once. (Contributed by Victor Stinner in99289.) -
Add platform triplets for 64-bit LoongArch:
- loongarch64-linux-gnusf
- loongarch64-linux-gnuf32
- loongarch64-linux-gnu
(Contributed by Zhang Na in
90656.) -
PYTHON_FOR_REGENnow require Python 3.10 or newer. -
Autoconf 2.71 and aclocal 1.16.4 is now required to regenerate
configure. (Contributed by Christian Heimes in89886.) -
Windows builds and macOS installers from python.org now use OpenSSL 3.0.
C API Changes
New Features
-
697: Introduce theUnstable C API tier <unstable-c-api>, intended for low-level tools like debuggers and JIT compilers. This API may change in each minor release of CPython without deprecation warnings. Its contents are marked by thePyUnstable_prefix in names.Code object constructors:
PyUnstable_Code_New()(renamed fromPyCode_New)PyUnstable_Code_NewWithPosOnlyArgs()(renamed fromPyCode_NewWithPosOnlyArgs)
Extra storage for code objects (
523):PyUnstable_Eval_RequestCodeExtraIndex()(renamed from_PyEval_RequestCodeExtraIndex)PyUnstable_Code_GetExtra()(renamed from_PyCode_GetExtra)PyUnstable_Code_SetExtra()(renamed from_PyCode_SetExtra)
The original names will continue to be available until the respective API changes.
(Contributed by Petr Viktorin in
101101.) -
697: Add an API for extending types whose instance memory layout is opaque:PyType_Spec.basicsizecan be zero or negative to specify inheriting or extending the base class size.PyObject_GetTypeDataandPyType_GetTypeDataSizeadded to allow access to subclass-specific instance data.Py_TPFLAGS_ITEMS_AT_ENDandPyObject_GetItemDataadded to allow safely extending certain variable-sized types, includingPyType_Type.Py_RELATIVE_OFFSETadded to allow definingmembers <PyMemberDef>in terms of a subclass-specific struct.
(Contributed by Petr Viktorin in
103509.) -
Add the new
limited C API <limited-c-api>functionPyType_FromMetaclass, which generalizes the existingPyType_FromModuleAndSpecusing an additional metaclass argument. (Contributed by Wenzel Jakob in93012.) -
API for creating objects that can be called using
the vectorcall protocol <vectorcall>was added to theLimited API <stable>:Py_TPFLAGS_HAVE_VECTORCALLPyVectorcall_NARGSPyVectorcall_Callvectorcallfunc
The
Py_TPFLAGS_HAVE_VECTORCALLflag is now removed from a class when the class's~object.__call__method is reassigned. This makes vectorcall safe to use with mutable types (i.e. heap types without the immutable flag,Py_TPFLAGS_IMMUTABLETYPE). Mutable types that do not override~PyTypeObject.tp_callnow inherit thePy_TPFLAGS_HAVE_VECTORCALLflag. (Contributed by Petr Viktorin in93274.)The
Py_TPFLAGS_MANAGED_DICTandPy_TPFLAGS_MANAGED_WEAKREFflags have been added. This allows extensions classes to support object~object.__dict__and weakrefs with less bookkeeping, using less memory and with faster access. -
API for performing calls using
the vectorcall protocol <vectorcall>was added to theLimited API <stable>:PyObject_VectorcallPyObject_VectorcallMethodPY_VECTORCALL_ARGUMENTS_OFFSET
This means that both the incoming and outgoing ends of the vector call protocol are now available in the
Limited API <stable>. (Contributed by Wenzel Jakob in98586.) -
Add two new public functions,
PyEval_SetProfileAllThreadsandPyEval_SetTraceAllThreads, that allow to set tracing and profiling functions in all running threads in addition to the calling one. (Contributed by Pablo Galindo in93503.) -
Add new function
PyFunction_SetVectorcallto the C API which sets the vectorcall field of a givenPyFunctionObject. (Contributed by Andrew Frost in92257.) -
The C API now permits registering callbacks via
PyDict_AddWatcher,PyDict_Watchand related APIs to be called whenever a dictionary is modified. This is intended for use by optimizing interpreters, JIT compilers, or debuggers. (Contributed by Carl Meyer in91052.) -
Add
PyType_AddWatcherandPyType_WatchAPI to register callbacks to receive notification on changes to a type. (Contributed by Carl Meyer in91051.) -
Add
PyCode_AddWatcherandPyCode_ClearWatcherAPIs to register callbacks to receive notification on creation and destruction of code objects. (Contributed by Itamar Oren in91054.) -
Add
PyFrame_GetVarandPyFrame_GetVarStringfunctions to get a frame variable by its name. (Contributed by Victor Stinner in91248.) -
Add
PyErr_GetRaisedExceptionandPyErr_SetRaisedExceptionfor saving and restoring the current exception. These functions return and accept a single exception object, rather than the triple arguments of the now-deprecatedPyErr_FetchandPyErr_Restore. This is less error prone and a bit more efficient. (Contributed by Mark Shannon in101578.) -
Add
_PyErr_ChainExceptions1, which takes an exception instance, to replace the legacy-API_PyErr_ChainExceptions, which is now deprecated. (Contributed by Mark Shannon in101578.) -
Add
PyException_GetArgsandPyException_SetArgsas convenience functions for retrieving and modifying the~BaseException.argspassed to the exception's constructor. (Contributed by Mark Shannon in101578.) -
Add
PyErr_DisplayException, which takes an exception instance, to replace the legacy-api!PyErr_Display. (Contributed by Irit Katriel in102755).
-
683: Introduce Immortal Objects, which allows objects to bypass reference counts, and related changes to the C-API:_Py_IMMORTAL_REFCNT: The reference count that defines an object as immortal._Py_IsImmortalChecks if an object has the immortal reference count.PyObject_HEAD_INITThis will now initialize reference count to_Py_IMMORTAL_REFCNTwhen used withPy_BUILD_CORE.SSTATE_INTERNED_IMMORTALAn identifier for interned unicode objects that are immortal.SSTATE_INTERNED_IMMORTAL_STATICAn identifier for interned unicode objects that are immortal and staticsys.getunicodeinternedsizeThis returns the total number of unicode objects that have been interned. This is now needed forrefleak.pyto correctly track reference counts and allocated blocks
(Contributed by Eddie Elizondo in
84436.) -
684: Add the newPy_NewInterpreterFromConfigfunction andPyInterpreterConfig, which may be used to create sub-interpreters with their own GILs. (Seewhatsnew312-pep684for more info.) (Contributed by Eric Snow in104110.) -
In the limited C API version 3.12,
Py_INCREFandPy_DECREFfunctions are now implemented as opaque function calls to hide implementation details. (Contributed by Victor Stinner in105387.)
Porting to Python 3.12
-
Legacy Unicode APIs based on
Py_UNICODE*representation has been removed. Please migrate to APIs based on UTF-8 orwchar_t*. -
Argument parsing functions like
PyArg_ParseTupledoesn't supportPy_UNICODE*based format (e.g.u,Z) anymore. Please migrate to other formats for Unicode likes,z,es, andU. -
tp_weaklistfor all static builtin types is alwaysNULL. This is an internal-only field onPyTypeObjectbut we're pointing out the change in case someone happens to be accessing the field directly anyway. To avoid breakage, consider using the existing public C-API instead, or, if necessary, the (internal-only)_PyObject_GET_WEAKREFS_LISTPTR()macro. -
This internal-only
PyTypeObject.tp_subclassesmay now not be a valid object pointer. Its type was changed tovoid *to reflect this. We mention this in case someone happens to be accessing the internal-only field directly.To get a list of subclasses, call the Python method
~type.__subclasses__(usingPyObject_CallMethod, for example). -
Add support of more formatting options (left aligning, octals, uppercase hexadecimals,
intmax_t,ptrdiff_t,wchar_tC strings, variable width and precision) inPyUnicode_FromFormatandPyUnicode_FromFormatV. (Contributed by Serhiy Storchaka in98836.) -
An unrecognized format character in
PyUnicode_FromFormatandPyUnicode_FromFormatVnow sets aSystemError. In previous versions it caused all the rest of the format string to be copied as-is to the result string, and any extra arguments discarded. (Contributed by Serhiy Storchaka in95781.) -
Fix wrong sign placement in
PyUnicode_FromFormatandPyUnicode_FromFormatV. (Contributed by Philip Georgi in95504.) -
Extension classes wanting to add a
~object.__dict__or weak reference slot should usePy_TPFLAGS_MANAGED_DICTandPy_TPFLAGS_MANAGED_WEAKREFinstead oftp_dictoffsetandtp_weaklistoffset, respectively. The use oftp_dictoffsetandtp_weaklistoffsetis still supported, but does not fully support multiple inheritance (95589), and performance may be worse. Classes declaringPy_TPFLAGS_MANAGED_DICTmust call!_PyObject_VisitManagedDictand!_PyObject_ClearManagedDictto traverse and clear their instance's dictionaries. To clear weakrefs, callPyObject_ClearWeakRefs, as before. -
The
PyUnicode_FSDecoderfunction no longer accepts bytes-like paths, likebytearrayandmemoryviewtypes: only the exactbytestype is accepted for bytes strings. (Contributed by Victor Stinner in98393.) -
The
Py_CLEAR,Py_SETREFandPy_XSETREFmacros now only evaluate their arguments once. If an argument has side effects, these side effects are no longer duplicated. (Contributed by Victor Stinner in98724.) -
The interpreter's error indicator is now always normalized. This means that
PyErr_SetObject,PyErr_SetStringand the other functions that set the error indicator now normalize the exception before storing it. (Contributed by Mark Shannon in101578.) -
_Py_RefTotalis no longer authoritative and only kept around for ABI compatibility. Note that it is an internal global and only available on debug builds. If you happen to be using it then you'll need to start using_Py_GetGlobalRefTotal(). -
The following functions now select an appropriate metaclass for the newly created type:
PyType_FromSpecPyType_FromSpecWithBasesPyType_FromModuleAndSpec
Creating classes whose metaclass overrides
~PyTypeObject.tp_newis deprecated, and in Python 3.14+ it will be disallowed. Note that these functions ignoretp_newof the metaclass, possibly allowing incomplete initialization.Note that
PyType_FromMetaclass(added in Python 3.12) already disallows creating classes whose metaclass overridestp_new(~object.__new__in Python).Since
tp_newoverrides almost everythingPyType_From*functions do, the two are incompatible with each other. The existing behavior -- ignoring the metaclass for several steps of type creation -- is unsafe in general, since (meta)classes assume thattp_newwas called. There is no simple general workaround. One of the following may work for you:- If you control the metaclass, avoid using
tp_newin it:- If initialization can be skipped, it can be done in
~PyTypeObject.tp_initinstead. - If the metaclass doesn't need to be instantiated from Python, set its
tp_newtoNULLusing thePy_TPFLAGS_DISALLOW_INSTANTIATIONflag. This makes it acceptable forPyType_From*functions.
- If initialization can be skipped, it can be done in
- Avoid
PyType_From*functions: if you don't need C-specific features (slots or setting the instance size), create types bycalling <call>the metaclass. - If you know the
tp_newcan be skipped safely, filter the deprecation warning out usingwarnings.catch_warningsfrom Python.
-
PyOS_InputHookandPyOS_ReadlineFunctionPointerare no longer called insubinterpreters <sub-interpreter-support>. This is because clients generally rely on process-wide global state (since these callbacks have no way of recovering extension module state).This also avoids situations where extensions may find themselves running in a subinterpreter that they don't support (or haven't yet been loaded in). See
104668for more info. -
PyLongObjecthas had its internals changed for better performance. Although the internals ofPyLongObjectare private, they are used by some extension modules. The internal fields should no longer be accessed directly, instead the API functions beginningPyLong_...should be used instead. Two new unstable API functions are provided for efficient access to the value ofPyLongObjects which fit into a single machine word:PyUnstable_Long_IsCompactPyUnstable_Long_CompactValue
-
Custom allocators, set via
PyMem_SetAllocator, are now required to be thread-safe, regardless of memory domain. Allocators that don't have their own state, including "hooks", are not affected. If your custom allocator is not already thread-safe and you need guidance then please create a new GitHub issue and CC@ericsnowcurrently.
Deprecated
-
In accordance with
699, thema_version_tagfield inPyDictObjectis deprecated for extension modules. Accessing this field will generate a compiler warning at compile time. This field will be removed in Python 3.14. (Contributed by Ramvikrams and Kumar Aditya in101193. PEP by Ken Jin.) -
Deprecate global configuration variable:
!Py_DebugFlag: usePyConfig.parser_debug!Py_VerboseFlag: usePyConfig.verbose!Py_QuietFlag: usePyConfig.quiet!Py_InteractiveFlag: usePyConfig.interactive!Py_InspectFlag: usePyConfig.inspect!Py_OptimizeFlag: usePyConfig.optimization_level!Py_NoSiteFlag: usePyConfig.site_import!Py_BytesWarningFlag: usePyConfig.bytes_warning!Py_FrozenFlag: usePyConfig.pathconfig_warnings!Py_IgnoreEnvironmentFlag: usePyConfig.use_environment!Py_DontWriteBytecodeFlag: usePyConfig.write_bytecode!Py_NoUserSiteDirectory: usePyConfig.user_site_directory!Py_UnbufferedStdioFlag: usePyConfig.buffered_stdio!Py_HashRandomizationFlag: usePyConfig.use_hash_seedandPyConfig.hash_seed!Py_IsolatedFlag: usePyConfig.isolated!Py_LegacyWindowsFSEncodingFlag: usePyPreConfig.legacy_windows_fs_encoding!Py_LegacyWindowsStdioFlag: usePyConfig.legacy_windows_stdio!Py_FileSystemDefaultEncoding: usePyConfig.filesystem_encoding!Py_HasFileSystemDefaultEncoding: usePyConfig.filesystem_encoding!Py_FileSystemDefaultEncodeErrors: usePyConfig.filesystem_errors!Py_UTF8Mode: usePyPreConfig.utf8_mode(seePy_PreInitialize)
The
Py_InitializeFromConfigAPI should be used withPyConfiginstead. (Contributed by Victor Stinner in77782.) -
Creating
immutable types <Py_TPFLAGS_IMMUTABLETYPE>with mutable bases is deprecated and will be disabled in Python 3.14. (95388) -
The
structmember.hheader is deprecated, though it continues to be available and there are no plans to remove it.Its contents are now available just by including
Python.h, with aPyprefix added if it was missing:PyMemberDef,PyMember_GetOneandPyMember_SetOne- Type macros like
Py_T_INT,Py_T_DOUBLE, etc. (previouslyT_INT,T_DOUBLE, etc.) - The flags
Py_READONLY(previouslyREADONLY) andPy_AUDIT_READ(previously all uppercase)
Several items are not exposed from
Python.h:T_OBJECT(usePy_T_OBJECT_EX)T_NONE(previously undocumented, and pretty quirky)- The macro
WRITE_RESTRICTEDwhich does nothing. - The macros
RESTRICTEDandREAD_RESTRICTED, equivalents ofPy_AUDIT_READ. - In some configurations,
<stddef.h>is not included fromPython.h. It should be included manually when usingoffsetof().
The deprecated header continues to provide its original contents under the original names. Your old code can stay unchanged, unless the extra include and non-namespaced macros bother you greatly.
(Contributed in
47146by Petr Viktorin, based on earlier work by Alexander Belopolsky and Matthias Braun.) -
PyErr_FetchandPyErr_Restoreare deprecated. UsePyErr_GetRaisedExceptionandPyErr_SetRaisedExceptioninstead. (Contributed by Mark Shannon in101578.) -
!PyErr_Displayis deprecated. UsePyErr_DisplayExceptioninstead. (Contributed by Irit Katriel in102755). -
_PyErr_ChainExceptionsis deprecated. Use_PyErr_ChainExceptions1instead. (Contributed by Irit Katriel in102192.) -
Using
PyType_FromSpec,PyType_FromSpecWithBasesorPyType_FromModuleAndSpecto create a class whose metaclass overrides~PyTypeObject.tp_newis deprecated. Call the metaclass instead.
Pending removal in Python 3.14
- The
ma_version_tagfield inPyDictObjectfor extension modules (699;101193). - Creating
immutable types <Py_TPFLAGS_IMMUTABLETYPE>with mutable bases (95388).
Pending removal in Python 3.15
-
The
!PyImport_ImportModuleNoBlock: UsePyImport_ImportModuleinstead. -
!PyWeakref_GetObjectand!PyWeakref_GET_OBJECT: UsePyWeakref_GetRefinstead. The pythoncapi-compat project can be used to getPyWeakref_GetRefon Python 3.12 and older. -
!PyUnicode_AsDecodedObject: UsePyCodec_Decodeinstead. -
!PyUnicode_AsDecodedUnicode: UsePyCodec_Decodeinstead; Note that some codecs (for example, "base64") may return a type other thanstr, such asbytes. -
!PyUnicode_AsEncodedObject: UsePyCodec_Encodeinstead. -
!PyUnicode_AsEncodedUnicode: UsePyCodec_Encodeinstead; Note that some codecs (for example, "base64") may return a type other thanbytes, such asstr. -
Python initialization functions, deprecated in Python 3.13:
!Py_GetPath: UsePyConfig_Get("module_search_paths") <PyConfig_Get>(sys.path) instead.!Py_GetPrefix: UsePyConfig_Get("base_prefix") <PyConfig_Get>(sys.base_prefix) instead. UsePyConfig_Get("prefix") <PyConfig_Get>(sys.prefix) ifvirtual environments <venv-def>need to be handled.!Py_GetExecPrefix: UsePyConfig_Get("base_exec_prefix") <PyConfig_Get>(sys.base_exec_prefix) instead. UsePyConfig_Get("exec_prefix") <PyConfig_Get>(sys.exec_prefix) ifvirtual environments <venv-def>need to be handled.!Py_GetProgramFullPath: UsePyConfig_Get("executable") <PyConfig_Get>(sys.executable) instead.!Py_GetProgramName: UsePyConfig_Get("executable") <PyConfig_Get>(sys.executable) instead.!Py_GetPythonHome: UsePyConfig_Get("home") <PyConfig_Get>or thePYTHONHOMEenvironment variable instead.
The pythoncapi-compat project can be used to get
PyConfig_Geton Python 3.13 and older.
Pending removal in Python 3.16
-
Functions to configure Python's initialization, deprecated in Python 3.11:
!PySys_SetArgvEx(): SetPyConfig.argvinstead.!PySys_SetArgv(): SetPyConfig.argvinstead.!Py_SetProgramName(): SetPyConfig.program_nameinstead.!Py_SetPythonHome(): SetPyConfig.homeinstead.
The
Py_InitializeFromConfigAPI should be used withPyConfiginstead. -
Global configuration variables:
!Py_DebugFlag: UsePyConfig.parser_debugorPyConfig_Get("parser_debug") <PyConfig_Get>instead.!Py_VerboseFlag: UsePyConfig.verboseorPyConfig_Get("verbose") <PyConfig_Get>instead.!Py_QuietFlag: UsePyConfig.quietorPyConfig_Get("quiet") <PyConfig_Get>instead.!Py_InteractiveFlag: UsePyConfig.interactiveorPyConfig_Get("interactive") <PyConfig_Get>instead.!Py_InspectFlag: UsePyConfig.inspectorPyConfig_Get("inspect") <PyConfig_Get>instead.!Py_OptimizeFlag: UsePyConfig.optimization_levelorPyConfig_Get("optimization_level") <PyConfig_Get>instead.!Py_NoSiteFlag: UsePyConfig.site_importorPyConfig_Get("site_import") <PyConfig_Get>instead.!Py_BytesWarningFlag: UsePyConfig.bytes_warningorPyConfig_Get("bytes_warning") <PyConfig_Get>instead.!Py_FrozenFlag: UsePyConfig.pathconfig_warningsorPyConfig_Get("pathconfig_warnings") <PyConfig_Get>instead.!Py_IgnoreEnvironmentFlag: UsePyConfig.use_environmentorPyConfig_Get("use_environment") <PyConfig_Get>instead.!Py_DontWriteBytecodeFlag: UsePyConfig.write_bytecodeorPyConfig_Get("write_bytecode") <PyConfig_Get>instead.!Py_NoUserSiteDirectory: UsePyConfig.user_site_directoryorPyConfig_Get("user_site_directory") <PyConfig_Get>instead.!Py_UnbufferedStdioFlag: UsePyConfig.buffered_stdioorPyConfig_Get("buffered_stdio") <PyConfig_Get>instead.!Py_HashRandomizationFlag: UsePyConfig.use_hash_seedandPyConfig.hash_seedorPyConfig_Get("hash_seed") <PyConfig_Get>instead.!Py_IsolatedFlag: UsePyConfig.isolatedorPyConfig_Get("isolated") <PyConfig_Get>instead.!Py_LegacyWindowsFSEncodingFlag: UsePyPreConfig.legacy_windows_fs_encodingorPyConfig_Get("legacy_windows_fs_encoding") <PyConfig_Get>instead.!Py_LegacyWindowsStdioFlag: UsePyConfig.legacy_windows_stdioorPyConfig_Get("legacy_windows_stdio") <PyConfig_Get>instead.!Py_FileSystemDefaultEncoding,!Py_HasFileSystemDefaultEncoding: UsePyConfig.filesystem_encodingorPyConfig_Get("filesystem_encoding") <PyConfig_Get>instead.!Py_FileSystemDefaultEncodeErrors: UsePyConfig.filesystem_errorsorPyConfig_Get("filesystem_errors") <PyConfig_Get>instead.!Py_UTF8Mode: UsePyPreConfig.utf8_modeorPyConfig_Get("utf8_mode") <PyConfig_Get>instead. (seePy_PreInitialize)
The
Py_InitializeFromConfigAPI should be used withPyConfigto set these options. OrPyConfig_Getcan be used to get these options at runtime. -
Py_UNICODEwhich was deprecated by393.
Pending removal in future versions
The following APIs are deprecated and will be removed, although there is currently no date scheduled for their removal.
Py_TPFLAGS_HAVE_FINALIZE: Unneeded since Python 3.8.PyErr_Fetch: UsePyErr_GetRaisedExceptioninstead.PyErr_NormalizeException: UsePyErr_GetRaisedExceptioninstead.PyErr_Restore: UsePyErr_SetRaisedExceptioninstead.PyOS_AfterFork: UsePyOS_AfterFork_Childinstead.PySlice_GetIndicesEx: UsePySlice_UnpackandPySlice_AdjustIndicesinstead.PyUnicode_READY: Unneeded since Python 3.12!PyErr_Display: UsePyErr_DisplayExceptioninstead.!_PyErr_ChainExceptions: Use!_PyErr_ChainExceptions1instead.!PyBytesObject.ob_shashmember: callPyObject_Hashinstead.- Thread Local Storage (TLS) API:
PyThread_create_key: UsePyThread_tss_allocinstead.PyThread_delete_key: UsePyThread_tss_freeinstead.PyThread_set_key_value: UsePyThread_tss_setinstead.PyThread_get_key_value: UsePyThread_tss_getinstead.PyThread_delete_key_value: UsePyThread_tss_deleteinstead.PyThread_ReInitTLS: Unneeded since Python 3.7.
Removed
- Remove the
token.hheader file. There was never any public tokenizer C API. Thetoken.hheader file was only designed to be used by Python internals. (Contributed by Victor Stinner in92651.) - Legacy Unicode APIs have been removed. See
623for detail.!PyUnicode_WCHAR_KIND!PyUnicode_AS_UNICODE!PyUnicode_AsUnicode!PyUnicode_AsUnicodeAndSize!PyUnicode_AS_DATA!PyUnicode_FromUnicode!PyUnicode_GET_SIZE!PyUnicode_GetSize!PyUnicode_GET_DATA_SIZE
- Remove the
PyUnicode_InternImmortal()function macro. (Contributed by Victor Stinner in85858.)
谢谢你的反馈!