- Editor
TBD
This article explains the new features in Python 3.13, compared to 3.12.
For full details, see the changelog <changelog>
.
Note
Prerelease users should be aware that this document is currently in draft form. It will be updated substantially as Python 3.13 moves towards release, so it's worth checking back even after reading earlier versions.
Important deprecations, removals or restrictions:
PEP 594 <whatsnew313-pep594>
: The remaining 19 "dead batteries" have been removed from the standard library:!aifc
,!audioop
,!cgi
,!cgitb
,!chunk
,!crypt
,!imghdr
,!mailcap
,!msilib
,!nis
,!nntplib
,!ossaudiodev
,!pipes
,!sndhdr
,!spwd
,!sunau
,!telnetlib
,!uu
and!xdrlib
.602
("Annual Release Cycle for Python") has been updated:- Python 3.9 - 3.12 have one and a half years of full support, followed by three and a half years of security fixes.
- Python 3.13 and later have two years of full support, followed by three years of security fixes.
Interpreter improvements:
- A basic
JIT compiler <whatsnew313-jit-compiler>
was added. It is currently disabled by default (though we may turn it on later). Performance improvements are modest -- we expect to be improving this over the next few releases.
- The interpreter now colorizes error messages when displaying tracebacks by default. This feature can be controlled via the new
PYTHON_COLORS
environment variable as well as the canonicalNO_COLOR
andFORCE_COLOR
environment variables. See alsousing-on-controlling-color
. (Contributed by Pablo Galindo Salgado in112730
.) When an incorrect keyword argument is passed to a function, the error message now potentially suggests the correct keyword argument. (Contributed by Pablo Galindo Salgado and Shantanu Jain in
107944
.)>>> "better error messages!".split(max_split=1) Traceback (most recent call last): File "<stdin>", line 1, in <module> "better error messages!".split(max_split=1) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^ TypeError: split() got an unexpected keyword argument 'max_split'. Did you mean 'maxsplit'?
- Allow the count argument of
str.replace
to be a keyword. (Contributed by Hugo van Kemenade in106487
.) - Compiler now strip indents from docstrings. This will reduce the size of
bytecode cache <bytecode>
(e.g..pyc
file). For example, cache file size forsqlalchemy.orm.session
in SQLAlchemy 2.0 is reduced by about 5%. This change will affect tools using docstrings, likedoctest
. (Contributed by Inada Naoki in81283
.) - The
compile
built-in can now accept a new flag,ast.PyCF_OPTIMIZED_AST
, which is similar toast.PyCF_ONLY_AST
except that the returnedAST
is optimized according to the value of theoptimize
argument. (Contributed by Irit Katriel in108113
). multiprocessing
,concurrent.futures
,compileall
: Replaceos.cpu_count
withos.process_cpu_count
to select the default number of worker threads and processes. Get the CPU affinity if supported. (Contributed by Victor Stinner in109649
.)os.path.realpath
now resolves MS-DOS style file names even if the file is not accessible. (Contributed by Moonsik Park in82367
.)- Fixed a bug where a
global
declaration in anexcept
block is rejected when the global is used in theelse
block. (Contributed by Irit Katriel in111123
.) - Many functions now emit a warning if a boolean value is passed as a file descriptor argument. This can help catch some errors earlier. (Contributed by Serhiy Storchaka in
82626
.) - Added a new environment variable
PYTHON_FROZEN_MODULES
. It determines whether or not frozen modules are ignored by the import machinery, equivalent of the-X frozen_modules <-X>
command-line option. (Contributed by Yilei Yang in111374
.) - The new
PYTHON_HISTORY
environment variable can be used to change the location of a.python_history
file. (Contributed by Levi Sabah, Zackery Spytz and Hugo van Kemenade in73965
.) Add
PythonFinalizationError
exception. This exception derived fromRuntimeError
is raised when an operation is blocked during thePython finalization <interpreter shutdown>
.The following functions now raise PythonFinalizationError, instead of
RuntimeError
:_thread.start_new_thread
.subprocess.Popen
.os.fork
.os.forkpty
.
(Contributed by Victor Stinner in
114570
.)Allow controlling Expat >=2.6.0 reparse deferral (CVE-2023-52425) by adding five new methods:
xml.etree.ElementTree.XMLParser.flush
xml.etree.ElementTree.XMLPullParser.flush
xml.parsers.expat.xmlparser.GetReparseDeferralEnabled
xml.parsers.expat.xmlparser.SetReparseDeferralEnabled
!xml.sax.expatreader.ExpatParser.flush
(Contributed by Sebastian Pipping in
115623
.)When
asyncio.TaskGroup.create_task
is called on an inactiveasyncio.TaskGroup
, the given coroutine will be closed (which prevents aRuntimeWarning
about the given coroutine being never awaited).(Contributed by Arthur Tacca and Jason Zhang in
115957
.)The
ssl.create_default_context
API now includesssl.VERIFY_X509_PARTIAL_CHAIN
andssl.VERIFY_X509_STRICT
in its default flags.Note
ssl.VERIFY_X509_STRICT
may reject pre-5280
or malformed certificates that the underlying OpenSSL implementation otherwise would accept. While disabling this is not recommended, you can do so using:ctx = ssl.create_default_context() ctx.verify_flags &= ~ssl.VERIFY_X509_STRICT
(Contributed by William Woodruff in
112389
.)
- None yet.
- Add parameter deprecated in methods
~argparse.ArgumentParser.add_argument
and!add_parser
which allows to deprecate command-line options, positional arguments and subcommands. (Contributed by Serhiy Storchaka in83648
).
- Add
'w'
type code (Py_UCS4
) that can be used for Unicode strings. It can be used instead of'u'
type code, which is deprecated. (Contributed by Inada Naoki in80480
.) - Add
clear()
method in order to implementMutableSequence
. (Contributed by Mike Zimin in114894
.)
The constructors of node types in the
ast
module are now stricter in the arguments they accept, and have more intuitive behaviour when arguments are omitted.If an optional field on an AST node is not included as an argument when constructing an instance, the field will now be set to
None
. Similarly, if a list field is omitted, that field will now be set to an empty list. (Previously, in both cases, the attribute would be missing on the newly constructed AST node instance.)If other arguments are omitted, a
DeprecationWarning
is emitted. This will cause an exception in Python 3.15. Similarly, passing a keyword argument that does not map to a field on the AST node is now deprecated, and will raise an exception in Python 3.15.ast.parse
now accepts an optional argumentoptimize
which is passed on to thecompile
built-in. This makes it possible to obtain an optimizedAST
. (Contributed by Irit Katriel in108113
.)
asyncio.loop.create_unix_server
will now automatically remove the Unix socket when the server is closed. (Contributed by Pierre Ossman in111246
.)asyncio.DatagramTransport.sendto
will now send zero-length datagrams if called with an empty bytes object. The transport flow control also now accounts for the datagram header when calculating the buffer size. (Contributed by Jamie Phan in115199
.)
base64 ---
- Add
base64.z85encode
andbase64.z85decode
functions which allow encoding and decoding z85 data. See Z85 specification for more information. (Contributed by Matan Perelman in75299
.)
- Add
copy.replace
function which allows to create a modified copy of an object, which is especially useful for immutable objects. It supports named tuples created with the factory functioncollections.namedtuple
,~dataclasses.dataclass
instances, variousdatetime
objects,~inspect.Signature
objects,~inspect.Parameter
objects,code object <code-objects>
, and any user classes which define the!__replace__
method. (Contributed by Serhiy Storchaka in108751
.)
- Add
dbm.gnu.gdbm.clear
anddbm.ndbm.ndbm.clear
methods that remove all items from the database. (Contributed by Donghee Na in107122
.)
- Change the output of
dis
module functions to show logical labels for jump targets and exception handlers, rather than offsets. The offsets can be added with the new-O
command line option or theshow_offsets
parameter. (Contributed by Irit Katriel in112137
.)
- Add
dbm.gnu.gdbm.clear
anddbm.ndbm.ndbm.clear
methods that remove all items from the database. (Contributed by Donghee Na in107122
.) - Add new
dbm.sqlite3
backend, and make it the default!dbm
backend. (Contributed by Raymond Hettinger and Erlend E. Aasland in100414
.)
- The
doctest.DocTestRunner.run
method now counts the number of skipped tests. Adddoctest.DocTestRunner.skips
anddoctest.TestResults.skipped
attributes. (Contributed by Victor Stinner in108794
.)
email.utils.getaddresses
andemail.utils.parseaddr
now return('', '')
2-tuples in more situations where invalid email addresses are encountered instead of potentially inaccurate values. Add optional strict parameter to these two functions: usestrict=False
to get the old behavior, accept malformed inputs.getattr(email.utils, 'supports_strict_parsing', False)
can be use to check if the strict parameter is available. (Contributed by Thomas Dwyer and Victor Stinner for102988
to improve the CVE-2023-27043 fix.)
- Formatting for objects of type
fractions.Fraction
now supports the standard format specification mini-language rules for fill, alignment, sign handling, minimum width and grouping. (Contributed by Mark Dickinson in111320
.)
- Add
glob.translate
function that converts a path specification with shell-style wildcards to a regular expression. (Contributed by Barney Gale in72904
.)
The io.IOBase
finalizer now logs the close()
method errors with sys.unraisablehook
. Previously, errors were ignored silently by default, and only logged in Python Development Mode <devmode>
or on Python
built on debug mode <debug-build>
. (Contributed by Victor Stinner in 62948
.)
- Add the
ipaddress.IPv4Address.ipv6_mapped
property, which returns the IPv4-mapped IPv6 address. (Contributed by Charles Machalow in109466
.)
- Added a
strict
option toitertools.batched
. This raises aValueError
if the final batch is shorter than the specified batch size. (Contributed by Raymond Hettinger in113202
.)
- Add the allow_code parameter in module functions. Passing
allow_code=False
prevents serialization and de-serialization of code objects which are incompatible between Python versions. (Contributed by Serhiy Storchaka in113626
.)
A new function ~math.fma
for fused multiply-add operations has been added. This function computes x * y + z
with only a single round, and so avoids any intermediate loss of precision. It wraps the fma()
function provided by C99, and follows the specification of the IEEE 754 "fusedMultiplyAdd" operation for special cases. (Contributed by Mark Dickinson and Victor Stinner in 73468
.)
- The
mmap.mmap
class now has an~mmap.mmap.seekable
method that can be used when a seekable file-like object is required. The~mmap.mmap.seek
method now returns the new absolute position. (Contributed by Donghee Na and Sylvie Liberman in111835
.) mmap.mmap
now has a trackfd parameter on Unix; if it isFalse
, the file descriptor specified by fileno will not be duplicated. (Contributed by Zackery Spytz and Petr Viktorin in78502
.)
- Move
opcode.ENABLE_SPECIALIZATION
to_opcode.ENABLE_SPECIALIZATION
. This field was added in 3.12, it was never documented and is not intended for external usage. (Contributed by Irit Katriel in105481
.) - Removed
opcode.is_pseudo
,opcode.MIN_PSEUDO_OPCODE
andopcode.MAX_PSEUDO_OPCODE
, which were added in 3.12, were never documented or exposed throughdis
, and were not intended to be used externally.
- Add
os.process_cpu_count
function to get the number of logical CPUs usable by the calling thread of the current process. (Contributed by Victor Stinner in109649
.) - Add a low level interface for Linux's timer notification file descriptors via
os.timerfd_create
,os.timerfd_settime
,os.timerfd_settime_ns
,os.timerfd_gettime
, andos.timerfd_gettime_ns
,os.TFD_NONBLOCK
,os.TFD_CLOEXEC
,os.TFD_TIMER_ABSTIME
, andos.TFD_TIMER_CANCEL_ON_SET
(Contributed by Masaru Tsuchiyama in108277
.) os.cpu_count
andos.process_cpu_count
can be overridden through the new environment variablePYTHON_CPU_COUNT
or the new command-line option-X cpu_count <-X>
. This option is useful for users who need to limit CPU resources of a container system without having to modify the container (application code). (Contributed by Donghee Na in109595
.)- Add support of
os.lchmod
and the follow_symlinks argument inos.chmod
on Windows. Note that the default value of follow_symlinks in!os.lchmod
isFalse
on Windows. (Contributed by Serhiy Storchaka in59616
.) - Add support of
os.fchmod
and a file descriptor inos.chmod
on Windows. (Contributed by Serhiy Storchaka in113191
.) os.posix_spawn
now acceptsenv=None
, which makes the newly spawned process use the current process environment. (Contributed by Jakub Kulik in113119
.)os.posix_spawn
gains anos.POSIX_SPAWN_CLOSEFROM
attribute for use infile_actions=
on platforms that support :c!posix_spawn_file_actions_addclosefrom_np
. (Contributed by Jakub Kulik in113117
.)
- Add
os.path.isreserved
to check if a path is reserved on the current system. This function is only available on Windows. (Contributed by Barney Gale in88569
.) - On Windows,
os.path.isabs
no longer considers paths starting with exactly one (back)slash to be absolute. (Contributed by Barney Gale and Jon Foster in44626
.)
- Add
pathlib.UnsupportedOperation
, which is raised instead ofNotImplementedError
when a path operation isn't supported. (Contributed by Barney Gale in89812
.) - Add
pathlib.Path.from_uri
, a new constructor to create apathlib.Path
object from a 'file' URI (file://
). (Contributed by Barney Gale in107465
.) - Add
pathlib.PurePath.full_match
for matching paths with shell-style wildcards, including the recursive wildcard "**
". (Contributed by Barney Gale in73435
.) - Add follow_symlinks keyword-only argument to
pathlib.Path.glob
,~pathlib.Path.rglob
,~pathlib.Path.is_file
,~pathlib.Path.is_dir
,~pathlib.Path.owner
,~pathlib.Path.group
. (Contributed by Barney Gale in77609
and105793
, and Kamil Turek in107962
). - Return files and directories from
pathlib.Path.glob
and~pathlib.Path.rglob
when given a pattern that ends with "**
". In earlier versions, only directories were returned. (Contributed by Barney Gale in70303
).
- Add ability to move between chained exceptions during post mortem debugging in
~pdb.pm
using the newexceptions [exc_number]
command for Pdb. (Contributed by Matthias Bussonnier in106676
.) - Expressions/statements whose prefix is a pdb command are now correctly identified and executed. (Contributed by Tian Gao in
108464
.) sys.path[0]
will no longer be replaced by the directory of the script being debugged whensys.flags.safe_path
is set (via the-P
command line option orPYTHONSAFEPATH
environment variable). (Contributed by Tian Gao and Christian Walther in111762
.)
- Add
queue.Queue.shutdown
(along withqueue.ShutDown
) for queue termination. (Contributed by Laurie Opperman and Yves Duprat in104750
.)
- Rename
!re.error
tore.PatternError
for improved clarity.!re.error
is kept for backward compatibility.
- A
ResourceWarning
is now emitted if asqlite3.Connection
object is notclosed <sqlite3.Connection.close>
explicitly. (Contributed by Erlend E. Aasland in105539
.) - Add filter keyword-only parameter to
sqlite3.Connection.iterdump
for filtering database objects to dump. (Contributed by Mariusz Felisiak in91602
.)
- Add
statistics.kde
for kernel density estimation. This makes it possible to estimate a continuous probability density function from a fixed number of discrete samples. (Contributed by Raymond Hettinger in115863
.)
- The
subprocess
module now uses theos.posix_spawn
function in more situations. Notably in the default case ofclose_fds=True
on more recent versions of platforms including Linux, FreeBSD, and Solaris where the C library provides :c!posix_spawn_file_actions_addclosefrom_np
. On Linux this should perform similar to our existing Linux :c!vfork
based code. A private control knob!subprocess._USE_POSIX_SPAWN
can be set toFalse
if you need to forcesubprocess
not to ever useos.posix_spawn
. Please report your reason and platform details in the CPython issue tracker if you set this so that we can improve our API selection logic for everyone. (Contributed by Jakub Kulik in113117
.)
- Add the
sys._is_interned
function to test if the string was interned. This function is not guaranteed to exist in all implementations of Python. (Contributed by Serhiy Storchaka in78573
.)
- On Windows,
time.monotonic()
now uses theQueryPerformanceCounter()
clock to have a resolution better than 1 us, instead of theGetTickCount64()
clock which has a resolution of 15.6 ms. (Contributed by Victor Stinner in88494
.)
- Add
tkinter
widget methods:!tk_busy_hold
,!tk_busy_configure
,!tk_busy_cget
,!tk_busy_forget
,!tk_busy_current
, and!tk_busy_status
. (Contributed by Miguel, klappnase and Serhiy Storchaka in72684
.) - The
tkinter
widget method!wm_attributes
now accepts the attribute name without the minus prefix to get window attributes, e.g.w.wm_attributes('alpha')
and allows to specify attributes and values to set as keyword arguments, e.g.w.wm_attributes(alpha=0.5)
. Add new optional keyword-only parameter return_python_dict: callingw.wm_attributes(return_python_dict=True)
returns the attributes as a dict instead of a tuple. (Contributed by Serhiy Storchaka in43457
.) - Add new optional keyword-only parameter return_ints in the
!Text.count
method. Passingreturn_ints=True
makes it always returning the single count as an integer instead of a 1-tuple orNone
. (Contributed by Serhiy Storchaka in97928
.) - Add support of the "vsapi" element type in the
~tkinter.ttk.Style.element_create
method oftkinter.ttk.Style
. (Contributed by Serhiy Storchaka in68166
.)
- Add show_group parameter to
traceback.TracebackException.format_exception_only
to format the nested exceptions of aBaseExceptionGroup
instance, recursively. (Contributed by Irit Katriel in105292
.) - Add the field exc_type_str to
~traceback.TracebackException
, which holds a string display of the exc_type. Deprecate the field exc_type which holds the type object itself. Add parameter save_exc_type (defaultTrue
) to indicate whetherexc_type
should be saved. (Contributed by Irit Katriel in112332
.)
- Add
typing.get_protocol_members
to return the set of members defining atyping.Protocol
. Addtyping.is_protocol
to check whether a class is atyping.Protocol
. (Contributed by Jelle Zijlstra in104873
.) - Add
typing.ReadOnly
, a special typing construct to mark an item of atyping.TypedDict
as read-only for type checkers. See705
for more details.
- The Unicode database has been updated to version 15.1.0. (Contributed by James Gerity in
109559
.)
- Add support for adding source control management (SCM) ignore files to a virtual environment's directory. By default, Git is supported. This is implemented as opt-in via the API which can be extended to support other SCMs (
venv.EnvBuilder
andvenv.create
), and opt-out via the CLI (using--without-scm-ignore-files
). (Contributed by Brett Cannon in108125
.)
- The new
warnings.deprecated
decorator provides a way to communicate deprecations tostatic type checkers <static type checker>
and to warn on usage of deprecated classes and functions. A runtime deprecation warning may also be emitted when a decorated function or class is used at runtime. See702
. (Contributed by Jelle Zijlstra in104003
.)
- Add the
!close
method for the iterator returned by~xml.etree.ElementTree.iterparse
for explicit cleaning up. (Contributed by Serhiy Storchaka in69893
.)
textwrap.indent
is now ~30% faster than before for large input. (Contributed by Inada Naoki in107369
.)- The
subprocess
module usesos.posix_spawn
in more situations including the default whereclose_fds=True
on many modern platforms. This should provide a noteworthy performance increase launching processes on FreeBSD and Solaris. See thesubprocess
section above for details. (Contributed by Jakub Kulik in113117
.)
When CPython is configured using the --enable-experimental-jit
option, a just-in-time compiler is added which can speed up some Python programs.
The internal architecture is roughly as follows.
- We start with specialized Tier 1 bytecode. See
What's new in 3.11 <whatsnew311-pep659>
for details. - When the Tier 1 bytecode gets hot enough, it gets translated to a new, purely internal Tier 2 IR, a.k.a. micro-ops ("uops").
- The Tier 2 IR uses the same stack-based VM as Tier 1, but the instruction format is better suited to translation to machine code.
- We have several optimization passes for Tier 2 IR, which are applied before it is interpreted or translated to machine code.
- There is a Tier 2 interpreter, but it is mostly intended for debugging the earlier stages of the optimization pipeline. If the JIT is not enabled, the Tier 2 interpreter can be invoked by passing Python the
-X uops
option or by setting thePYTHON_UOPS
environment variable to1
. - When the
--enable-experimental-jit
option is used, the optimized Tier 2 IR is translated to machine code, which is then executed. This does not require additional runtime options. - The machine code translation process uses an architecture called copy-and-patch. It has no runtime dependencies, but there is a new build-time dependency on LLVM.
(JIT by Brandt Bucher, inspired by a paper by Haoran Xu and Fredrik Kjolstad. Tier 2 IR by Mark Shannon and Guido van Rossum. Tier 2 optimizer by Ken Jin.)
array
:array
's'u'
format code, deprecated in docs since Python 3.3, emitsDeprecationWarning
since 3.13 and will be removed in Python 3.16. Use the'w'
format code instead. (contributed by Hugo van Kemenade in80480
)ctypes
: Deprecate undocumented!ctypes.SetPointerType
and!ctypes.ARRAY
functions. Replacectypes.ARRAY(item_type, size)
withitem_type * size
. (Contributed by Victor Stinner in105733
.)decimal
: Deprecate non-standard format specifier "N" fordecimal.Decimal
. It was not documented and only supported in the C implementation. (Contributed by Serhiy Storchaka in89902
.)dis
: Thedis.HAVE_ARGUMENT
separator is deprecated. Check membership in~dis.hasarg
instead. (Contributed by Irit Katriel in109319
.)getopt
andoptparse
modules: They are nowsoft deprecated
: theargparse
module should be used for new projects. Previously, theoptparse
module was already deprecated, its removal was not scheduled, and no warnings was emitted: so there is no change in practice. (Contributed by Victor Stinner in106535
.)gettext
: Emit deprecation warning for non-integer numbers ingettext
functions and methods that consider plural forms even if the translation was not found. (Contributed by Serhiy Storchaka in88434
.)http.server
:http.server.CGIHTTPRequestHandler
now emits aDeprecationWarning
as it will be removed in 3.15. Process-based CGI HTTP servers have been out of favor for a very long time. This code was outdated, unmaintained, and rarely used. It has a high potential for both security and functionality bugs. This includes removal of the--cgi
flag to thepython -m http.server
command line in 3.15.pathlib
:pathlib.PurePath.is_reserved
is deprecated and scheduled for removal in Python 3.15. Useos.path.isreserved
to detect reserved paths on Windows.pydoc
: Deprecate undocumented!pydoc.ispackage
function. (Contributed by Zackery Spytz in64020
.)sqlite3
: Passing more than one positional argument tosqlite3.connect
and thesqlite3.Connection
constructor is deprecated. The remaining parameters will become keyword-only in Python 3.15.Deprecate passing name, number of arguments, and the callable as keyword arguments for the following
sqlite3.Connection
APIs:~sqlite3.Connection.create_function
~sqlite3.Connection.create_aggregate
Deprecate passing the callback callable by keyword for the following
sqlite3.Connection
APIs:~sqlite3.Connection.set_authorizer
~sqlite3.Connection.set_progress_handler
~sqlite3.Connection.set_trace_callback
The affected parameters will become positional-only in Python 3.15.
(Contributed by Erlend E. Aasland in
107948
and108278
.)sys
:sys._enablelegacywindowsfsencoding
function. Replace it with thePYTHONLEGACYWINDOWSFSENCODING
environment variable. (Contributed by Inada Naoki in73427
.)traceback
: The field exc_type oftraceback.TracebackException
is deprecated. Use exc_type_str instead.typing
:- Creating a
typing.NamedTuple
class using keyword arguments to denote the fields (NT = NamedTuple("NT", x=int, y=int)
) is deprecated, and will be disallowed in Python 3.15. Use the class-based syntax or the functional syntax instead. (Contributed by Alex Waygood in105566
.) - When using the functional syntax to create a
typing.NamedTuple
class or atyping.TypedDict
class, failing to pass a value to the 'fields' parameter (NT = NamedTuple("NT")
orTD = TypedDict("TD")
) is deprecated. PassingNone
to the 'fields' parameter (NT = NamedTuple("NT", None)
orTD = TypedDict("TD", None)
) is also deprecated. Both will be disallowed in Python 3.15. To create a NamedTuple class with 0 fields, useclass NT(NamedTuple): pass
orNT = NamedTuple("NT", [])
. To create a TypedDict class with 0 fields, useclass TD(TypedDict): pass
orTD = TypedDict("TD", {})
. (Contributed by Alex Waygood in105566
and105570
.) typing.no_type_check_decorator
is deprecated, and scheduled for removal in Python 3.15. After eight years in thetyping
module, it has yet to be supported by any major type checkers. (Contributed by Alex Waygood in106309
.)typing.AnyStr
is deprecated. In Python 3.16, it will be removed fromtyping.__all__
, and aDeprecationWarning
will be emitted when it is imported or accessed. It will be removed entirely in Python 3.18. Use the newtype parameter syntax <type-params>
instead. (Contributed by Michael The in107116
.)
- Creating a
wave
: Deprecate thegetmark()
,setmark()
andgetmarkers()
methods of thewave.Wave_read
andwave.Wave_write
classes. They will be removed in Python 3.15. (Contributed by Victor Stinner in105096
.)- Calling
frame.clear
on a suspended frame raisesRuntimeError
(as has always been the case for an executing frame). (Contributed by Irit Katriel in79932
.) - Assignment to a function's
~function.__code__
attribute where the new code object's type does not match the function's type, is deprecated. The different types are: plain function, generator, async generator and coroutine. (Contributed by Irit Katriel in81137
.) - The undocumented and unused
tarfile
attribute oftarfile.TarFile
is deprecated and scheduled for removal in Python 3.16. platform.java_ver
is deprecated and will be removed in 3.15. It was largely untested, had a confusing API, and was only useful for Jython support. (Contributed by Nikita Sobolev in116349
.)
argparse
: The type, choices, and metavar parameters of!argparse.BooleanOptionalAction
are 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 aDeprecationWarning
to 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.Constant
instead. (Contributed by Serhiy Storchaka in90953
.)collections.abc
: Deprecated~collections.abc.ByteString
. Prefer!Sequence
or~collections.abc.Buffer
. For use in typing, prefer a union, likebytes | bytearray
, orcollections.abc.Buffer
. (Contributed by Shantanu Jain in91896
.)email
: Deprecated the isdst parameter inemail.utils.localtime
. (Contributed by Alan Williams in72346
.)importlib
:__package__
and__cached__
will cease to be set or taken into consideration by the import system (97879
).importlib.abc
deprecated classes:!importlib.abc.ResourceReader
!importlib.abc.Traversable
!importlib.abc.TraversableResources
Use
importlib.resources.abc
classes instead:importlib.resources.abc.Traversable
importlib.resources.abc.TraversableResources
(Contributed by Jason R. Coombs and Hugo van Kemenade in
93963
.)itertools
had 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_context
or~multiprocessing.set_start_method
APIs to explicitly specify when your code requires'fork'
. Seemultiprocessing-start-methods
.pathlib
:~pathlib.PurePath.is_relative_to
and~pathlib.PurePath.relative_to
: passing additional arguments is deprecated.pkgutil
:~pkgutil.find_loader
and~pkgutil.get_loader
now raiseDeprecationWarning
; useimportlib.util.find_spec
instead. (Contributed by Nikita Sobolev in97850
.)pty
:master_open()
: usepty.openpty
.slave_open()
: usepty.openpty
.
shutil.rmtree
onerror parameter is deprecated in 3.12, and will be removed in 3.14: use the onexc parameter instead.sqlite3
:~sqlite3.version
and~sqlite3.version_info
.~sqlite3.Cursor.execute
and~sqlite3.Cursor.executemany
ifnamed placeholders <sqlite3-placeholders>
are used and parameters is a sequence instead of adict
.- date and datetime adapter, date and timestamp converter: see the
sqlite3
documentation for suggested replacement recipes.
types.CodeType
: Accessing~codeobject.co_lnotab
was deprecated in626
since 3.10 and was planned to be removed in 3.12, but it only got a properDeprecationWarning
in 3.12. May be removed in 3.14. (Contributed by Nikita Sobolev in101866
.)typing
:~typing.ByteString
, deprecated since Python 3.9, now causes aDeprecationWarning
to be emitted when it is used.!urllib.parse.Quoter
is deprecated: it was not intended to be a public API. (Contributed by Gregory P. Smith in88168
.)xml.etree.ElementTree
: Testing the truth value of an~xml.etree.ElementTree.Element
is deprecated and will raise an exception in Python 3.14.
http.server.CGIHTTPRequestHandler
will be removed along with its related--cgi
flag topython -m http.server
. It was obsolete and rarely used. No direct replacement exists. Anything is better than CGI to interface a web server with a request handler.locale
:locale.getdefaultlocale
was deprecated in Python 3.11 and originally planned for removal in Python 3.13 (90817
), but removal has been postponed to Python 3.15. Uselocale.setlocale()
,locale.getencoding()
andlocale.getlocale()
instead. (Contributed by Hugo van Kemenade in111187
.)pathlib
:pathlib.PurePath.is_reserved
is deprecated and scheduled for removal in Python 3.15. Useos.path.isreserved
to detect reserved paths on Windows.threading
: Passing any arguments tothreading.RLock
is now deprecated. C version allows any numbers of args and kwargs, but they are just ignored. Python version does not allow any arguments. All arguments will be removed fromthreading.RLock
in Python 3.15. (Contributed by Nikita Sobolev in102029
.)typing.NamedTuple
:- The undocumented keyword argument syntax for creating NamedTuple classes (
NT = NamedTuple("NT", x=int)
) is deprecated, and will be disallowed in 3.15. Use the class-based syntax or the functional syntax instead. - When using the functional syntax to create a NamedTuple class, failing to pass a value to the 'fields' parameter (
NT = NamedTuple("NT")
) is deprecated. PassingNone
to the 'fields' parameter (NT = NamedTuple("NT", None)
) is also deprecated. Both will be disallowed in Python 3.15. To create a NamedTuple class with 0 fields, useclass NT(NamedTuple): pass
orNT = NamedTuple("NT", [])
.
- The undocumented keyword argument syntax for creating NamedTuple classes (
typing.TypedDict
: When using the functional syntax to create a TypedDict class, failing to pass a value to the 'fields' parameter (TD = TypedDict("TD")
) is deprecated. PassingNone
to the 'fields' parameter (TD = TypedDict("TD", None)
) is also deprecated. Both will be disallowed in Python 3.15. To create a TypedDict class with 0 fields, useclass TD(TypedDict): pass
orTD = TypedDict("TD", {})
.wave
: Deprecate thegetmark()
,setmark()
andgetmarkers()
methods of thewave.Wave_read
andwave.Wave_write
classes. They will be removed in Python 3.15. (Contributed by Victor Stinner in105096
.)platform.java_ver
is deprecated and will be removed in 3.15. It was largely untested, had a confusing API, and was only useful for Jython support. (Contributed by Nikita Sobolev in116349
.)
array.array
'u'
type (:cwchar_t
): use the'w'
type instead (Py_UCS4
).
The following APIs were deprecated in earlier Python versions and will be removed, although there is currently no date scheduled for their removal.
argparse
: Nesting argument groups and nesting mutually exclusive groups are deprecated.builtins
:~bool
, bitwise inversion on bool.bool(NotImplemented)
.- 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
,is
andor
. 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
. - Delegation of
int()
to__trunc__()
method.
calendar
:calendar.January
andcalendar.February
constants are deprecated and replaced bycalendar.JANUARY
andcalendar.FEBRUARY
. (Contributed by Prince Roshan in103636
.)codeobject.co_lnotab
: use thecodeobject.co_lines
method 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
:load_module()
method: useexec_module()
instead.~importlib.util.cache_from_source
debug_override parameter is deprecated: use the optimization parameter instead.
importlib.metadata
:EntryPoints
tuple interface.- Implicit
None
on return values.
mailbox
: Use of StringIO input and text mode is deprecated, use BytesIO and binary mode instead.os
: Callingos.register_at_fork
in multi-threaded process.!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
.)!sre_compile
,!sre_constants
and!sre_parse
modules.ssl
options and protocols:ssl.SSLContext
without protocol argument is deprecated.ssl.SSLContext
:~ssl.SSLContext.set_npn_protocols
and!selected_npn_protocol
are deprecated: use ALPN instead.ssl.OP_NO_SSL*
optionsssl.OP_NO_TLS*
optionsssl.PROTOCOL_SSLv3
ssl.PROTOCOL_TLS
ssl.PROTOCOL_TLSv1
ssl.PROTOCOL_TLSv1_1
ssl.PROTOCOL_TLSv1_2
ssl.TLSVersion.SSLv3
ssl.TLSVersion.TLSv1
ssl.TLSVersion.TLSv1_1
sysconfig.is_python_build
check_home parameter is deprecated and ignored.threading
methods:!threading.Condition.notifyAll
: use~threading.Condition.notify_all
.!threading.Event.isSet
: use~threading.Event.is_set
.!threading.Thread.isDaemon
,threading.Thread.setDaemon
: usethreading.Thread.daemon
attribute.!threading.Thread.getName
,threading.Thread.setName
: usethreading.Thread.name
attribute.!threading.currentThread
: usethreading.current_thread
.!threading.activeCount
: usethreading.active_count
.
typing.Text
(92332
).unittest.IsolatedAsyncioTestCase
: it is deprecated to return a value that is notNone
from a test case.urllib.parse
deprecated functions:~urllib.parse.urlparse
insteadsplitattr()
splithost()
splitnport()
splitpasswd()
splitport()
splitquery()
splittag()
splittype()
splituser()
splitvalue()
to_bytes()
urllib.request
:~urllib.request.URLopener
and~urllib.request.FancyURLopener
style of invoking requests is deprecated. Use newer~urllib.request.urlopen
functions and methods.wsgiref
:SimpleHandler.stdout.write()
should not do partial writes.zipimport.zipimporter.load_module
is deprecated: use~zipimport.zipimporter.exec_module
instead.
594
removed 19 modules from the standard library, deprecated in Python 3.11:!aifc
. (Contributed by Victor Stinner in104773
.)!audioop
. (Contributed by Victor Stinner in104773
.)!chunk
. (Contributed by Victor Stinner in104773
.)!cgi
and!cgitb
.cgi.FieldStorage
can typically be replaced withurllib.parse.parse_qsl
forGET
andHEAD
requests, and theemail.message
module or multipart PyPI project forPOST
andPUT
.cgi.parse()
can be replaced by callingurllib.parse.parse_qs
directly on the desired query string, except formultipart/form-data
input, which can be handled as described forcgi.parse_multipart()
.cgi.parse_header()
can be replaced with the functionality in theemail
package, which implements the same MIME RFCs. For example, withemail.message.EmailMessage
:from email.message import EmailMessage msg = EmailMessage() msg['content-type'] = 'application/json; charset="utf8"' main, params = msg.get_content_type(), msg['content-type'].params
cgi.parse_multipart()
can be replaced with the functionality in theemail
package (e.g.email.message.EmailMessage
andemail.message.Message
) which implements the same MIME RFCs, or with the multipart PyPI project.
(Contributed by Victor Stinner in
104773
.)!crypt
module and its private!_crypt
extension. Thehashlib
module is a potential replacement for certain use cases. Otherwise, the following PyPI projects can be used:- bcrypt: Modern password hashing for your software and your servers.
- passlib: Comprehensive password hashing framework supporting over 30 schemes.
- argon2-cffi: The secure Argon2 password hashing algorithm.
- legacycrypt: Wrapper to the POSIX crypt library call and associated functionality.
(Contributed by Victor Stinner in
104773
.)!imghdr
: use the projects filetype, puremagic, or python-magic instead. (Contributed by Victor Stinner in104773
.)!mailcap
. Themimetypes
module provides an alternative. (Contributed by Victor Stinner in104773
.)!msilib
. (Contributed by Zachary Ware in104773
.)!nis
. (Contributed by Victor Stinner in104773
.)!nntplib
: the PyPI nntplib project can be used instead. (Contributed by Victor Stinner in104773
.)!ossaudiodev
: use the pygame project for audio playback. (Contributed by Victor Stinner in104780
.)!pipes
: use thesubprocess
module instead. (Contributed by Victor Stinner in104773
.)!sndhdr
: use the projects filetype, puremagic, or python-magic instead. (Contributed by Victor Stinner in104773
.)!spwd
: the python-pam project can be used instead. (Contributed by Victor Stinner in104773
.)!sunau
. (Contributed by Victor Stinner in104773
.)!telnetlib
, use the projects telnetlib3 or Exscript instead. (Contributed by Victor Stinner in104773
.)!uu
: thebase64
module is a modern alternative. (Contributed by Victor Stinner in104773
.)!xdrlib
. (Contributed by Victor Stinner in104773
.)
- Remove the
2to3
program and the!lib2to3
module, deprecated in Python 3.11. (Contributed by Victor Stinner in104780
.)
- Remove the undocumented
!configparser.LegacyInterpolation
class, deprecated in the docstring since Python 3.2, and with a deprecation warning since Python 3.11. (Contributed by Hugo van Kemenade in104886
.)
Remove
importlib.resources
deprecated methods:contents()
is_resource()
open_binary()
open_text()
path()
read_binary()
read_text()
Use
importlib.resources.files()
instead. Refer to importlib-resources: Migrating from Legacy for migration advice. (Contributed by Jason R. Coombs in106532
.)- Remove deprecated
~object.__getitem__
access for!importlib.metadata.EntryPoint
objects. (Contributed by Jason R. Coombs in113175
.)
- Remove
locale.resetlocale()
function deprecated in Python 3.11: uselocale.setlocale(locale.LC_ALL, "")
instead. (Contributed by Victor Stinner in104783
.)
logging
: Remove undocumented and untestedLogger.warn()
andLoggerAdapter.warn()
methods andlogging.warn()
function. Deprecated since Python 3.3, they were aliases to thelogging.Logger.warning
method,!logging.LoggerAdapter.warning
method andlogging.warning
function. (Contributed by Victor Stinner in105376
.)
- Remove support for using
pathlib.Path
objects as context managers. This functionality was deprecated and made a no-op in Python 3.9.
- Remove undocumented, never working, and deprecated
re.template
function andre.TEMPLATE
flag (andre.T
alias). (Contributed by Serhiy Storchaka and Nikita Sobolev in105687
.)
- Remove the
!tkinter.tix
module, deprecated in Python 3.6. The third-party Tix library which the module wrapped is unmaintained. (Contributed by Zachary Ware in75552
.)
- Remove the
!turtle.RawTurtle.settiltangle
method, deprecated in docs since Python 3.1 and with a deprecation warning since Python 3.11. (Contributed by Hugo van Kemenade in104876
.)
- Namespaces
typing.io
andtyping.re
, deprecated in Python 3.8, are now removed. The items in those namespaces can be imported directly fromtyping
. (Contributed by Sebastian Rittau in92871
.) - Remove support for the keyword-argument method of creating
typing.TypedDict
types, deprecated in Python 3.11. (Contributed by Tomas Roun in104786
.)
Removed the following
unittest
functions, deprecated in Python 3.11:!unittest.findTestCases
!unittest.makeSuite
!unittest.getTestCaseNames
Use
~unittest.TestLoader
methods instead:unittest.TestLoader.loadTestsFromModule
unittest.TestLoader.loadTestsFromTestCase
unittest.TestLoader.getTestCaseNames
(Contributed by Hugo van Kemenade in
104835
.)- Remove the untested and undocumented
!unittest.TestProgram.usageExit
method, deprecated in Python 3.11. (Contributed by Hugo van Kemenade in104992
.)
- Remove cafile, capath and cadefault parameters of the
urllib.request.urlopen
function, deprecated in Python 3.6: use the context parameter instead. Please usessl.SSLContext.load_cert_chain
instead, or letssl.create_default_context
select the system's trusted CA certificates for you. (Contributed by Victor Stinner in105382
.)
- Remove the untested and undocumented
webbrowser
!MacOSX
class, deprecated in Python 3.11. Use the!MacOSXOSAScript
class (introduced in Python 3.2) instead. (Contributed by Hugo van Kemenade in104804
.) - Remove deprecated
webbrowser.MacOSXOSAScript._name
attribute. Usewebbrowser.MacOSXOSAScript.name <webbrowser.controller.name>
attribute instead. (Contributed by Nikita Sobolev in105546
.)
- None yet
- The oparg of
YIELD_VALUE
is now1
if the yield is part of a yield-from or await, and0
otherwise. The oparg ofRESUME
was changed to add a bit indicating whether the except-depth is 1, which is needed to optimize closing of generators. (Contributed by Irit Katriel in111354
.)
This section lists previously described changes and other bugfixes that may require changes to your code.
- Functions :c
PyDict_GetItem
, :cPyDict_GetItemString
, :cPyMapping_HasKey
, :cPyMapping_HasKeyString
, :cPyObject_HasAttr
, :cPyObject_HasAttrString
, and :cPySys_GetObject
, which clear all errors which occurred when calling them, now report them usingsys.unraisablehook
. You may replace them with other functions as recommended in the documentation. (Contributed by Serhiy Storchaka in106672
.) - An
OSError
is now raised bygetpass.getuser
for any failure to retrieve a username, instead ofImportError
on non-Unix platforms orKeyError
on Unix platforms where the password database is empty. The
threading
module now expects the!_thread
module to have an_is_main_interpreter
attribute. It is a function with no arguments that returnTrue
if the current interpreter is the main interpreter.Any library or application that provides a custom
_thread
module must provide_is_main_interpreter()
, just like the module's other "private" attributes. (See112826
.)mailbox.Maildir
now ignores files with a leading dot. (Contributed by Zackery Spytz in65559
.)pathlib.Path.glob
and~pathlib.Path.rglob
now return both files and directories if a pattern that ends with "**
" is given, rather than directories only. Users may add a trailing slash to match only directories.
- Autoconf 2.71 and aclocal 1.16.4 is now required to regenerate the
configure
script. (Contributed by Christian Heimes in89886
.) - SQLite 3.15.2 or newer is required to build the
sqlite3
extension module. (Contributed by Erlend Aasland in105875
.) - Python built with
configure
--with-trace-refs
(tracing references) is now ABI compatible with the Python release build anddebug build <debug-build>
. (Contributed by Victor Stinner in108634
.) - Building CPython now requires a compiler with support for the C11 atomic library, GCC built-in atomic functions, or MSVC interlocked intrinsics.
- The
errno
,fcntl
,grp
,md5
,pwd
,resource
,winsound
,_ctypes_test
,_multiprocessing.posixshmem
,_scproxy
,_stat
,_testimportmultiple
and_uuid
C extensions are now built with thelimited C API <limited-c-api>
. (Contributed by Victor Stinner in85283
.) wasm32-wasi
is now a tier 2 platform. (Contributed by Brett Cannon in115192
.)wasm32-emscripten
is no longer a supported platform. (Contributed by Brett Cannon in115192
.)
- You no longer have to define the
PY_SSIZE_T_CLEAN
macro before includingPython.h
when using#
formats informat codes <arg-parsing-string-and-buffers>
. APIs accepting the format codes always usePy_ssize_t
for#
formats. (Contributed by Inada Naoki in104922
.) - The keywords parameter of :c
PyArg_ParseTupleAndKeywords
and :cPyArg_VaParseTupleAndKeywords
now has type :cchar * const *
in C and :cconst char * const *
in C++, instead of :cchar **
. It makes these functions compatible with arguments of type :cconst char * const *
, :cconst char **
or :cchar * const *
in C++ and :cchar * const *
in C without an explicit type cast. This can be overridden with the :cPY_CXX_CONST
macro. (Contributed by Serhiy Storchaka in65210
.) - Add :c
PyImport_AddModuleRef
: similar to :cPyImport_AddModule
, but return astrong reference
instead of aborrowed reference
. (Contributed by Victor Stinner in105922
.) - Add :c
PyWeakref_GetRef
function: similar to :cPyWeakref_GetObject
but returns astrong reference
, orNULL
if the referent is no longer live. (Contributed by Victor Stinner in105927
.) - Add :c
PyObject_GetOptionalAttr
and :cPyObject_GetOptionalAttrString
, variants of :cPyObject_GetAttr
and :cPyObject_GetAttrString
which don't raiseAttributeError
if the attribute is not found. These variants are more convenient and faster if the missing attribute should not be treated as a failure. (Contributed by Serhiy Storchaka in106521
.) - Add :c
PyMapping_GetOptionalItem
and :cPyMapping_GetOptionalItemString
: variants of :cPyObject_GetItem
and :cPyMapping_GetItemString
which don't raiseKeyError
if the key is not found. These variants are more convenient and faster if the missing key should not be treated as a failure. (Contributed by Serhiy Storchaka in106307
.) Add fixed variants of functions which silently ignore errors:
- :c
PyObject_HasAttrWithError
replaces :cPyObject_HasAttr
. - :c
PyObject_HasAttrStringWithError
replaces :cPyObject_HasAttrString
. - :c
PyMapping_HasKeyWithError
replaces :cPyMapping_HasKey
. - :c
PyMapping_HasKeyStringWithError
replaces :cPyMapping_HasKeyString
.
New functions return not only
1
for true and0
for false, but also-1
for error.(Contributed by Serhiy Storchaka in
108511
.)- :c
- If Python is built in
debug mode <debug-build>
orwith assertions <--with-assertions>
, :cPyTuple_SET_ITEM
and :cPyList_SET_ITEM
now check the index argument with an assertion. (Contributed by Victor Stinner in106168
.) - Add :c
PyModule_Add
function: similar to :cPyModule_AddObjectRef
and :cPyModule_AddObject
but always steals a reference to the value. (Contributed by Serhiy Storchaka in86493
.) - Add :c
PyDict_GetItemRef
and :cPyDict_GetItemStringRef
functions: similar to :cPyDict_GetItemWithError
but returning astrong reference
instead of aborrowed reference
. Moreover, these functions return -1 on error and so checkingPyErr_Occurred()
is not needed. (Contributed by Victor Stinner in106004
.) - Added :c
PyDict_SetDefaultRef
, which is similar to :cPyDict_SetDefault
but returns astrong reference
instead of aborrowed reference
. This function returns-1
on error,0
on insertion, and1
if the key was already present in the dictionary. (Contributed by Sam Gross in112066
.) - Add :c
PyDict_ContainsString
function: same as :cPyDict_Contains
, but key is specified as a :cconst char*
UTF-8 encoded bytes string, rather than a :cPyObject*
. (Contributed by Victor Stinner in108314
.) - Added :c
PyList_GetItemRef
function: similar to :cPyList_GetItem
but returns astrong reference
instead of aborrowed reference
. - Add :c
Py_IsFinalizing
function: check if the main Python interpreter isshutting down <interpreter shutdown>
. (Contributed by Victor Stinner in108014
.) - Add :c
PyLong_AsInt
function: similar to :cPyLong_AsLong
, but store the result in a C :cint
instead of a C :clong
. Previously, it was known as the private function :c!_PyLong_AsInt
(with an underscore prefix). (Contributed by Victor Stinner in108014
.) - Python built with
configure
--with-trace-refs
(tracing references) now supports theLimited API <limited-c-api>
. (Contributed by Victor Stinner in108634
.) - Add :c
PyObject_VisitManagedDict
and :cPyObject_ClearManagedDict
functions which must be called by the traverse and clear functions of a type using :cPy_TPFLAGS_MANAGED_DICT
flag. The pythoncapi-compat project can be used to get these functions on Python 3.11 and 3.12. (Contributed by Victor Stinner in107073
.) - Add :c
PyUnicode_EqualToUTF8AndSize
and :cPyUnicode_EqualToUTF8
functions: compare Unicode object with a :cconst char*
UTF-8 encoded string and return true (1
) if they are equal, or false (0
) otherwise. These functions do not raise exceptions. (Contributed by Serhiy Storchaka in110289
.) - Add :c
PyThreadState_GetUnchecked()
function: similar to :cPyThreadState_Get()
, but don't kill the process with a fatal error if it is NULL. The caller is responsible to check if the result is NULL. Previously, the function was private and known as_PyThreadState_UncheckedGet()
. (Contributed by Victor Stinner in108867
.) - Add :c
PySys_AuditTuple
function: similar to :cPySys_Audit
, but pass event arguments as a Pythontuple
object. (Contributed by Victor Stinner in85283
.) - :c
PyArg_ParseTupleAndKeywords
now supports non-ASCII keyword parameter names. (Contributed by Serhiy Storchaka in110815
.) - Add :c
PyMem_RawMalloc
, :cPyMem_RawCalloc
, :cPyMem_RawRealloc
and :cPyMem_RawFree
to the limited C API (version 3.13). (Contributed by Victor Stinner in85283
.) - Add :c
PySys_Audit
and :cPySys_AuditTuple
functions to the limited C API. (Contributed by Victor Stinner in85283
.) - Add :c
PyErr_FormatUnraisable
function: similar to :cPyErr_WriteUnraisable
, but allow customizing the warning message. (Contributed by Serhiy Storchaka in108082
.) - Add :c
PyList_Extend
and :cPyList_Clear
functions: similar to Pythonlist.extend()
andlist.clear()
methods. (Contributed by Victor Stinner in111138
.) - Add :c
PyDict_Pop
and :cPyDict_PopString
functions: remove a key from a dictionary and optionally return the removed value. This is similar todict.pop
, but without the default value and not raisingKeyError
if the key is missing. (Contributed by Stefan Behnel and Victor Stinner in111262
.) - Add :c
Py_HashPointer
function to hash a pointer. (Contributed by Victor Stinner in111545
.) Add PyTime C API:
- :c
PyTime_t
type. - :c
PyTime_MIN
and :cPyTime_MAX
constants. - :c
PyTime_AsSecondsDouble
:cPyTime_Monotonic
, :cPyTime_PerfCounter
, and :cPyTime_Time
functions.
(Contributed by Victor Stinner and Petr Viktorin in
110850
.)- :c
- Add :c
PyLong_AsNativeBytes
, :cPyLong_FromNativeBytes
and :cPyLong_FromUnsignedNativeBytes
functions to simplify converting between native integer types and Pythonint
objects. (Contributed by Steve Dower in111140
.) - Add :c
PyType_GetFullyQualifiedName
function to get the type's fully qualified name. Equivalent tof"{type.__module__}.{type.__qualname__}"
, ortype.__qualname__
iftype.__module__
is not a string or is equal to"builtins"
. (Contributed by Victor Stinner in111696
.) - Add :c
PyType_GetModuleName
function to get the type's module name. Equivalent to getting thetype.__module__
attribute. (Contributed by Eric Snow and Victor Stinner in111696
.) - Add support for
%T
,%T#
,%N
and%N#
formats to :cPyUnicode_FromFormat
: format the fully qualified name of an object type and of a type: call :cPyType_GetModuleName
. See737
for more information. (Contributed by Victor Stinner in111696
.)
Python.h
no longer includes the<ieeefp.h>
standard header. It was included for thefinite()
function which is now provided by the<math.h>
header. It should now be included explicitly if needed. Remove also theHAVE_IEEEFP_H
macro. (Contributed by Victor Stinner in108765
.)Python.h
no longer includes these standard header files:<time.h>
,<sys/select.h>
and<sys/time.h>
. If needed, they should now be included explicitly. For example,<time.h>
provides theclock()
andgmtime()
functions,<sys/select.h>
provides theselect()
function, and<sys/time.h>
provides thefutimes()
,gettimeofday()
andsetitimer()
functions. (Contributed by Victor Stinner in108765
.)- If the :c
Py_LIMITED_API
macro is defined, :c!Py_BUILD_CORE
, :c!Py_BUILD_CORE_BUILTIN
and :c!Py_BUILD_CORE_MODULE
macros are now undefined by<Python.h>
. (Contributed by Victor Stinner in85283
.) The old trashcan macros
Py_TRASHCAN_SAFE_BEGIN
andPy_TRASHCAN_SAFE_END
were removed. They should be replaced by the new macrosPy_TRASHCAN_BEGIN
andPy_TRASHCAN_END
.A tp_dealloc function that has the old macros, such as:
static void mytype_dealloc(mytype *p) { PyObject_GC_UnTrack(p); Py_TRASHCAN_SAFE_BEGIN(p); ... Py_TRASHCAN_SAFE_END }
should migrate to the new macros as follows:
static void mytype_dealloc(mytype *p) { PyObject_GC_UnTrack(p); Py_TRASHCAN_BEGIN(p, mytype_dealloc) ... Py_TRASHCAN_END }
Note that
Py_TRASHCAN_BEGIN
has a second argument which should be the deallocation function it is in.- On Windows,
Python.h
no longer includes the<stddef.h>
standard header file. If needed, it should now be included explicitly. For example, it providesoffsetof()
function, andsize_t
andptrdiff_t
types. Including<stddef.h>
explicitly was already needed by all other platforms, theHAVE_STDDEF_H
macro is only defined on Windows. (Contributed by Victor Stinner in108765
.)
- Passing optional arguments maxsplit, count and flags in module-level functions
re.split
,re.sub
andre.subn
as positional arguments is now deprecated. In future Python versions these parameters will bekeyword-only <keyword-only_parameter>
. (Contributed by Serhiy Storchaka in56166
.) - Deprecate the old
Py_UNICODE
andPY_UNICODE_TYPE
types: use directly the :cwchar_t
type instead. Since Python 3.3,Py_UNICODE
andPY_UNICODE_TYPE
are just aliases to :cwchar_t
. (Contributed by Victor Stinner in105156
.) Deprecate old Python initialization functions:
- :c
PySys_ResetWarnOptions
: clearsys.warnoptions
and!warnings.filters
instead. - :c
Py_GetExecPrefix
: getsys.exec_prefix
instead. - :c
Py_GetPath
: getsys.path
instead. - :c
Py_GetPrefix
: getsys.prefix
instead. - :c
Py_GetProgramFullPath
: getsys.executable
instead. - :c
Py_GetProgramName
: getsys.executable
instead. - :c
Py_GetPythonHome
: get :cPyConfig.home
orPYTHONHOME
environment variable instead.
Functions scheduled for removal in Python 3.15. (Contributed by Victor Stinner in
105145
.)- :c
- Deprecate the :c
PyImport_ImportModuleNoBlock
function which is just an alias to :cPyImport_ImportModule
since Python 3.3. Scheduled for removal in Python 3.15. (Contributed by Victor Stinner in105396
.) - Deprecate the :c
PyWeakref_GetObject
and :cPyWeakref_GET_OBJECT
functions, which return aborrowed reference
: use the new :cPyWeakref_GetRef
function instead, it returns astrong reference
. The pythoncapi-compat project can be used to get :cPyWeakref_GetRef
on Python 3.12 and older. (Contributed by Victor Stinner in105927
.)
- Removed chained
classmethod
descriptors (introduced in63272
). This can no longer be used to wrap other descriptors such asproperty
. The core design of this feature was flawed and caused a number of downstream problems. To "pass-through" aclassmethod
, consider using the!__wrapped__
attribute that was added in Python 3.10. (Contributed by Raymond Hettinger in89519
.) - Remove many APIs (functions, macros, variables) with names prefixed by
_Py
or_PY
(considered as private API). If your project is affected by one of these removals and you consider that the removed API should remain available, please open a new issue to request a public C API and addcc @vstinner
to the issue to notify Victor Stinner. (Contributed by Victor Stinner in106320
.) Remove functions deprecated in Python 3.9:
PyEval_CallObject()
,PyEval_CallObjectWithKeywords()
: use :cPyObject_CallNoArgs
or :cPyObject_Call
instead. Warning: :cPyObject_Call
positional arguments must be atuple
and must not beNULL
, keyword arguments must be adict
orNULL
, whereas removed functions checked arguments type and acceptedNULL
positional and keyword arguments. To replacePyEval_CallObjectWithKeywords(func, NULL, kwargs)
with :cPyObject_Call
, pass an empty tuple as positional arguments using :cPyTuple_New(0) <PyTuple_New>
.PyEval_CallFunction()
: use :cPyObject_CallFunction
instead.PyEval_CallMethod()
: use :cPyObject_CallMethod
instead.PyCFunction_Call()
: use :cPyObject_Call
instead.
(Contributed by Victor Stinner in
105107
.)Remove old buffer protocols deprecated in Python 3.0. Use
bufferobjects
instead.- :c
!PyObject_CheckReadBuffer
: Use :cPyObject_CheckBuffer
to test if the object supports the buffer protocol. Note that :cPyObject_CheckBuffer
doesn't guarantee that :cPyObject_GetBuffer
will succeed. To test if the object is actually readable, see the next example of :cPyObject_GetBuffer
. :c
!PyObject_AsCharBuffer
, :c!PyObject_AsReadBuffer
: :cPyObject_GetBuffer
and :cPyBuffer_Release
instead:Py_buffer view; if (PyObject_GetBuffer(obj, &view, PyBUF_SIMPLE) < 0) { return NULL; } // Use `view.buf` and `view.len` to read from the buffer. // You may need to cast buf as `(const char*)view.buf`. PyBuffer_Release(&view);
:c
!PyObject_AsWriteBuffer
: Use :cPyObject_GetBuffer
and :cPyBuffer_Release
instead:Py_buffer view; if (PyObject_GetBuffer(obj, &view, PyBUF_WRITABLE) < 0) { return NULL; } // Use `view.buf` and `view.len` to write to the buffer. PyBuffer_Release(&view);
(Contributed by Inada Naoki in
85275
.)- :c
Remove the following old functions to configure the Python initialization, deprecated in Python 3.11:
PySys_AddWarnOptionUnicode()
: use :cPyConfig.warnoptions
instead.PySys_AddWarnOption()
: use :cPyConfig.warnoptions
instead.PySys_AddXOption()
: use :cPyConfig.xoptions
instead.PySys_HasWarnOptions()
: use :cPyConfig.xoptions
instead.PySys_SetArgvEx()
: set :cPyConfig.argv
instead.PySys_SetArgv()
: set :cPyConfig.argv
instead.PySys_SetPath()
: set :cPyConfig.module_search_paths
instead.Py_SetPath()
: set :cPyConfig.module_search_paths
instead.Py_SetProgramName()
: set :cPyConfig.program_name
instead.Py_SetPythonHome()
: set :cPyConfig.home
instead.Py_SetStandardStreamEncoding()
: set :cPyConfig.stdio_encoding
instead, and set also maybe :cPyConfig.legacy_windows_stdio
(on Windows)._Py_SetProgramFullPath()
: set :cPyConfig.executable
instead.
Use the new :c
PyConfig
API of thePython Initialization Configuration <init-config>
instead (587
), added to Python 3.8. (Contributed by Victor Stinner in105145
.)- Remove the old trashcan macros
Py_TRASHCAN_SAFE_BEGIN
andPy_TRASHCAN_SAFE_END
. They should be replaced by the new macrosPy_TRASHCAN_BEGIN
andPy_TRASHCAN_END
. The new macros were added in Python 3.8 and the old macros were deprecated in Python 3.11. (Contributed by Irit Katriel in105111
.) - Remove
PyEval_InitThreads()
andPyEval_ThreadsInitialized()
functions, deprecated in Python 3.9. Since Python 3.7,Py_Initialize()
always creates the GIL: callingPyEval_InitThreads()
did nothing andPyEval_ThreadsInitialized()
always returned non-zero. (Contributed by Victor Stinner in105182
.) Remove
PyEval_AcquireLock()
andPyEval_ReleaseLock()
functions, deprecated in Python 3.2. They didn't update the current thread state. They can be replaced with:- :c
PyEval_SaveThread
and :cPyEval_RestoreThread
; - low-level :c
PyEval_AcquireThread
and :cPyEval_RestoreThread
; - or :c
PyGILState_Ensure
and :cPyGILState_Release
.
(Contributed by Victor Stinner in
105182
.)- :c
- Remove private
_PyObject_FastCall()
function: usePyObject_Vectorcall()
which is available since Python 3.8 (590
). (Contributed by Victor Stinner in106023
.) - Remove
cpython/pytime.h
header file: it only contained private functions. (Contributed by Victor Stinner in106316
.) - Remove
_PyInterpreterState_Get()
alias to :cPyInterpreterState_Get()
which was kept for backward compatibility with Python 3.8. The pythoncapi-compat project can be used to get :cPyInterpreterState_Get()
on Python 3.8 and older. (Contributed by Victor Stinner in106320
.) - The :c
PyModule_AddObject
function is nowsoft deprecated
: :cPyModule_Add
or :cPyModule_AddObjectRef
functions should be used instead. (Contributed by Serhiy Storchaka in86493
.)
- Creating immutable types (:c
Py_TPFLAGS_IMMUTABLETYPE
) with mutable bases using the C API. Global configuration variables:
- :c
Py_DebugFlag
: use :cPyConfig.parser_debug
- :c
Py_VerboseFlag
: use :cPyConfig.verbose
- :c
Py_QuietFlag
: use :cPyConfig.quiet
- :c
Py_InteractiveFlag
: use :cPyConfig.interactive
- :c
Py_InspectFlag
: use :cPyConfig.inspect
- :c
Py_OptimizeFlag
: use :cPyConfig.optimization_level
- :c
Py_NoSiteFlag
: use :cPyConfig.site_import
- :c
Py_BytesWarningFlag
: use :cPyConfig.bytes_warning
- :c
Py_FrozenFlag
: use :cPyConfig.pathconfig_warnings
- :c
Py_IgnoreEnvironmentFlag
: use :cPyConfig.use_environment
- :c
Py_DontWriteBytecodeFlag
: use :cPyConfig.write_bytecode
- :c
Py_NoUserSiteDirectory
: use :cPyConfig.user_site_directory
- :c
Py_UnbufferedStdioFlag
: use :cPyConfig.buffered_stdio
- :c
Py_HashRandomizationFlag
: use :cPyConfig.use_hash_seed
and :cPyConfig.hash_seed
- :c
Py_IsolatedFlag
: use :cPyConfig.isolated
- :c
Py_LegacyWindowsFSEncodingFlag
: use :cPyPreConfig.legacy_windows_fs_encoding
- :c
Py_LegacyWindowsStdioFlag
: use :cPyConfig.legacy_windows_stdio
- :c
!Py_FileSystemDefaultEncoding
: use :cPyConfig.filesystem_encoding
- :c
!Py_HasFileSystemDefaultEncoding
: use :cPyConfig.filesystem_encoding
- :c
!Py_FileSystemDefaultEncodeErrors
: use :cPyConfig.filesystem_errors
- :c
!Py_UTF8Mode
: use :cPyPreConfig.utf8_mode
(see :cPy_PreInitialize
)
The :c
Py_InitializeFromConfig
API should be used with :cPyConfig
instead.- :c
- :c
PyImport_ImportModuleNoBlock
: use :cPyImport_ImportModule
. - :c
PyWeakref_GET_OBJECT
: use :cPyWeakref_GetRef
instead. - :c
PyWeakref_GetObject
: use :cPyWeakref_GetRef
instead. - :c
!Py_UNICODE_WIDE
type: use :cwchar_t
instead. - :c
Py_UNICODE
type: use :cwchar_t
instead. - Python initialization functions:
- :c
PySys_ResetWarnOptions
: clearsys.warnoptions
and!warnings.filters
instead. - :c
Py_GetExecPrefix
: getsys.exec_prefix
instead. - :c
Py_GetPath
: getsys.path
instead. - :c
Py_GetPrefix
: getsys.prefix
instead. - :c
Py_GetProgramFullPath
: getsys.executable
instead. - :c
Py_GetProgramName
: getsys.executable
instead. - :c
Py_GetPythonHome
: get :cPyConfig.home
orPYTHONHOME
environment variable instead.
- :c
The following APIs were deprecated in earlier Python versions and will be removed, although there is currently no date scheduled for their removal.
- :c
Py_TPFLAGS_HAVE_FINALIZE
: no needed since Python 3.8. - :c
PyErr_Fetch
: use :cPyErr_GetRaisedException
. - :c
PyErr_NormalizeException
: use :cPyErr_GetRaisedException
. - :c
PyErr_Restore
: use :cPyErr_SetRaisedException
. - :c
PyModule_GetFilename
: use :cPyModule_GetFilenameObject
. - :c
PyOS_AfterFork
: use :cPyOS_AfterFork_Child()
. - :c
PySlice_GetIndicesEx
. - :c
!PyUnicode_AsDecodedObject
. - :c
!PyUnicode_AsDecodedUnicode
. - :c
!PyUnicode_AsEncodedObject
. - :c
!PyUnicode_AsEncodedUnicode
. - :c
PyUnicode_READY
: not needed since Python 3.12. - :c
!_PyErr_ChainExceptions
. - :c
!PyBytesObject.ob_shash
member: call :cPyObject_Hash
instead. - :c
!PyDictObject.ma_version_tag
member. - TLS API:
- :c
PyThread_create_key
: use :cPyThread_tss_alloc
. - :c
PyThread_delete_key
: use :cPyThread_tss_free
. - :c
PyThread_set_key_value
: use :cPyThread_tss_set
. - :c
PyThread_get_key_value
: use :cPyThread_tss_get
. - :c
PyThread_delete_key_value
: use :cPyThread_tss_delete
. - :c
PyThread_ReInitTLS
: no longer needed.
- :c
- Remove undocumented
PY_TIMEOUT_MAX
constant from the limited C API. (Contributed by Victor Stinner in110014
.)
- Python built with
configure
--with-pydebug
now supports a-X presite=package.module <-X>
command-line option. If used, it specifies a module that should be imported early in the lifecycle of the interpreter, beforesite.py
is executed. (Contributed by Łukasz Langa in110769
.)