Deprecations¶
Pending removal in Python 3.15¶
The import system:
Setting
__cached__on a module whilefailing to set__spec__.cachedis deprecated. In Python 3.15,__cached__will cease to be set ortake into consideration by the import system or standard library. (gh-97879)Setting
__package__on a module whilefailing to set__spec__.parentis deprecated. In Python 3.15,__package__will cease to be set ortake into consideration by the import system or standard library. (gh-97879)
The undocumented
ctypes.SetPointerType()functionhas been deprecated since Python 3.13.
The obsolete and rarely used
CGIHTTPRequestHandlerhas been deprecated since Python 3.13.No direct replacement exists.Anything is better than CGI to interfacea web server with a request handler.The
--cgiflag to thepython -m http.servercommand-line interface has been deprecated since Python 3.13.
load_module()method: useexec_module()instead.
The
getdefaultlocale()functionhas been deprecated since Python 3.11.Its removal was originally planned for Python 3.13 (gh-90817),but has been postponed to Python 3.15.Usegetlocale(),setlocale(),andgetencoding()instead.(Contributed by Hugo van Kemenade ingh-111187.)
PurePath.is_reserved()has been deprecated since Python 3.13.Useos.path.isreserved()to detect reserved paths on Windows.
java_ver()has been deprecated since Python 3.13.This function is only useful for Jython support, has a confusing API,and is largely untested.
Thecheck_home argument of
sysconfig.is_python_build()has beendeprecated since Python 3.12.
RLock()will 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.CodeType: Accessingco_lnotabwasdeprecated inPEP 626since 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 ingh-101866.)
The undocumented keyword argument syntax for creating
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
TypedDicts, failingto pass a value to thefields parameter (TD=TypedDict("TD")) orpassingNone(TD=TypedDict("TD",None)) has been deprecatedsince Python 3.13.UseclassTD(TypedDict):passorTD=TypedDict("TD",{})to create a TypedDict with zero field.The
typing.no_type_check_decorator()decorator functionhas been deprecated since Python 3.13.After eight years in thetypingmodule,it has yet to be supported by any major type checker.
wave:The
getmark(),setmark(),andgetmarkers()methods oftheWave_readandWave_writeclasseshave been deprecated since Python 3.13.
load_module()has been deprecated sincePython 3.10. Useexec_module()instead.(Contributed by Jiahao Li ingh-125746.)
Pending removal in Python 3.16¶
The import system:
Setting
__loader__on a module whilefailing to set__spec__.loaderis deprecated. In Python 3.16,__loader__will cease to be set ortaken into consideration by the import system or the standard library.
The
'u'format code (wchar_t)has been deprecated in documentation since Python 3.3and at runtime since Python 3.13.Use the'w'format code (Py_UCS4)for Unicode characters instead.
asyncio.iscoroutinefunction()is deprecatedand will be removed in Python 3.16;useinspect.iscoroutinefunction()instead.(Contributed by Jiahao Li and Kumar Aditya ingh-122875.)asynciopolicy system is deprecated and will be removed in Python 3.16.In particular, the following classes and functions are deprecated:Users should use
asyncio.run()orasyncio.Runnerwithloop_factory to use the desired event loop implementation.For example, to use
asyncio.SelectorEventLoopon Windows:importasyncioasyncdefmain():...asyncio.run(main(),loop_factory=asyncio.SelectorEventLoop)
(Contributed by Kumar Aditya ingh-127949.)
Bitwise inversion on boolean types,
~Trueor~Falsehas been deprecated since Python 3.12,as it produces surprising and unintuitive results (-2and-1).Usenotxinstead for the logical negation of a Boolean.In the rare case that you need the bitwise inversion ofthe underlying integer, convert tointexplicitly (~int(x)).
Calling the Python implementation of
functools.reduce()withfunctionorsequence as keyword arguments has been deprecated since Python 3.14.
Support for custom logging handlers with thestrm argument is deprecatedand scheduled for removal in Python 3.16. Define handlers with thestreamargument instead. (Contributed by Mariusz Felisiak ingh-115032.)
Valid extensions start with a ‘.’ or are empty for
mimetypes.MimeTypes.add_type().Undotted extensions are deprecated and willraise aValueErrorin Python 3.16.(Contributed by Hugo van Kemenade ingh-75223.)
The
ExecErrorexceptionhas been deprecated since Python 3.14.It has not been used by any function inshutilsince Python 3.4,and is now an alias ofRuntimeError.
The
Class.get_methodsmethodhas been deprecated since Python 3.14.
sys:The
_enablelegacywindowsfsencoding()functionhas been deprecated since Python 3.13.Use thePYTHONLEGACYWINDOWSFSENCODINGenvironment variable instead.
The
sysconfig.expand_makefile_vars()functionhas been deprecated since Python 3.14.Use thevarsargument ofsysconfig.get_paths()instead.
The undocumented and unused
TarFile.tarfileattributehas been deprecated since Python 3.13.
Pending removal in Python 3.17¶
collections.abc.ByteStringis scheduled for removal in Python 3.17.Use
isinstance(obj,collections.abc.Buffer)to test ifobjimplements thebuffer protocol at runtime. For usein type annotations, either useBufferor a unionthat explicitly specifies the types your code supports (e.g.,bytes|bytearray|memoryview).ByteStringwas originally intended to be an abstract class thatwould serve as a supertype of bothbytesandbytearray.However, since the ABC never had any methods, knowing that an object was aninstance ofByteStringnever actually told you anything usefulabout the object. Other common buffer types such asmemoryviewwere also never understood as subtypes ofByteString(either atruntime or by static type checkers).SeePEP 688 for more details.(Contributed by Shantanu Jain ingh-91896.)
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 Python3.17. Users should use documented introspection helpers liketyping.get_origin()andtyping.get_args()instead of relying on private implementation details.typing.ByteString, deprecated since Python 3.9, is scheduled for removal inPython 3.17.Use
isinstance(obj,collections.abc.Buffer)to test ifobjimplements thebuffer protocol at runtime. For usein type annotations, either useBufferor a unionthat explicitly specifies the types your code supports (e.g.,bytes|bytearray|memoryview).ByteStringwas originally intended to be an abstract class thatwould serve as a supertype of bothbytesandbytearray.However, since the ABC never had any methods, knowing that an object was aninstance ofByteStringnever actually told you anything usefulabout the object. Other common buffer types such asmemoryviewwere also never understood as subtypes ofByteString(either atruntime or by static type checkers).SeePEP 688 for more details.(Contributed by Shantanu Jain ingh-91896.)
Pending removal in Python 3.19¶
Pending removal in future versions¶
The following APIs will be removed in the future,although there is currently no date scheduled for their removal.
Nesting argument groups and nesting mutually exclusivegroups are deprecated.
Passing the undocumented keyword argumentprefix_chars to
add_argument_group()is nowdeprecated.The
argparse.FileTypetype converter is deprecated.
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
0inx,1orx,0if1else2. It allows confusing andambiguous expressions like[0x1forxiny](which can be interpreted as[0x1forxiny]or[0x1forxiny]). A syntax warning is raisedif the numeric literal is immediately followed by one of keywordsand,else,for,if,in,isandor. In a future release itwill be changed to a syntax error. (gh-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.Passing a complex number as thereal orimag argument in the
complex()constructor is now deprecated; it should only be passedas a single positional argument.(Contributed by Serhiy Storchaka ingh-109218.)
calendar:calendar.Januaryandcalendar.Februaryconstants aredeprecated and replaced bycalendar.JANUARYandcalendar.FEBRUARY.(Contributed by Prince Roshan ingh-103636.)codecs: useopen()instead ofcodecs.open(). (gh-133038)codeobject.co_lnotab: use thecodeobject.co_lines()methodinstead.utcnow():usedatetime.datetime.now(tz=datetime.UTC).utcfromtimestamp():usedatetime.datetime.fromtimestamp(timestamp,tz=datetime.UTC).
gettext: Plural value must be an integer.cache_from_source()debug_override parameter isdeprecated: use theoptimization parameter instead.
EntryPointstuple interface.Implicit
Noneon return values.
logging: thewarn()method has been deprecatedsince Python 3.3, usewarning()instead.mailbox: Use of StringIO input and text mode is deprecated, useBytesIO and binary mode instead.os: Callingos.register_at_fork()in multi-threaded process.pydoc.ErrorDuringImport: A tuple value forexc_info parameter isdeprecated, use an exception instance.re: More strict rules are now applied for numerical group referencesand group names in regular expressions. Only sequence of ASCII digits is nowaccepted as a numerical reference. The group name in bytes patterns andreplacement strings can now only contain ASCII letters and digits andunderscore.(Contributed by Serhiy Storchaka ingh-91760.)sre_compile,sre_constantsandsre_parsemodules.shutil:rmtree()’sonerror parameter is deprecated inPython 3.12; use theonexc parameter instead.ssloptions and protocols:ssl.SSLContextwithout protocol argument is deprecated.ssl.SSLContext:set_npn_protocols()andselected_npn_protocol()are deprecated: use ALPNinstead.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(): usenotify_all().threading.Event.isSet(): useis_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().
The internal class
typing._UnionGenericAliasis no longer used to implementtyping.Union. To preserve compatibility with users using this privateclass, a compatibility shim will be provided until at least Python 3.17. (Contributed byJelle Zijlstra ingh-105499.)unittest.IsolatedAsyncioTestCase: it is deprecated to return a valuethat is notNonefrom a test case.urllib.parsedeprecated functions:urlparse()insteadsplitattr()splithost()splitnport()splitpasswd()splitport()splitquery()splittag()splittype()splituser()splitvalue()to_bytes()
wsgiref:SimpleHandler.stdout.write()should not do partialwrites.xml.etree.ElementTree: Testing the truth value of anElementis deprecated. In a future release itwill always returnTrue. Prefer explicitlen(elem)orelemisnotNonetests instead.sys._clear_type_cache()is deprecated:usesys._clear_internal_caches()instead.
C API deprecations¶
Pending removal in Python 3.15¶
The
PyImport_ImportModuleNoBlock():UsePyImport_ImportModule()instead.PyWeakref_GetObject()andPyWeakref_GET_OBJECT():UsePyWeakref_GetRef()instead. Thepythoncapi-compat project can be used to getPyWeakref_GetRef()on Python 3.12 and older.Py_UNICODEtype and thePy_UNICODE_WIDEmacro:Usewchar_tinstead.PyUnicode_AsDecodedObject():UsePyCodec_Decode()instead.PyUnicode_AsDecodedUnicode():UsePyCodec_Decode()instead; Note that some codecs (for example, “base64”)may return a type other thanstr, such asbytes.PyUnicode_AsEncodedObject():UsePyCodec_Encode()instead.PyUnicode_AsEncodedUnicode():UsePyCodec_Encode()instead; 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")(sys.path) instead.Py_GetPrefix():UsePyConfig_Get("base_prefix")(sys.base_prefix) instead. UsePyConfig_Get("prefix")(sys.prefix) ifvirtual environments need to be handled.Py_GetExecPrefix():UsePyConfig_Get("base_exec_prefix")(sys.base_exec_prefix) instead. UsePyConfig_Get("exec_prefix")(sys.exec_prefix) ifvirtual environments need tobe handled.Py_GetProgramFullPath():UsePyConfig_Get("executable")(sys.executable) instead.Py_GetProgramName():UsePyConfig_Get("executable")(sys.executable) instead.Py_GetPythonHome():UsePyConfig_Get("home")or thePYTHONHOMEenvironment variable instead.
Thepythoncapi-compat project can be used to get
PyConfig_Get()on Python 3.13 and older.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.PySys_ResetWarnOptions():Clearsys.warnoptionsandwarnings.filtersinstead.
The
Py_InitializeFromConfig()API should be used withPyConfiginstead.Global configuration variables:
Py_DebugFlag:UsePyConfig.parser_debugorPyConfig_Get("parser_debug")instead.Py_VerboseFlag:UsePyConfig.verboseorPyConfig_Get("verbose")instead.Py_QuietFlag:UsePyConfig.quietorPyConfig_Get("quiet")instead.Py_InteractiveFlag:UsePyConfig.interactiveorPyConfig_Get("interactive")instead.Py_InspectFlag:UsePyConfig.inspectorPyConfig_Get("inspect")instead.Py_OptimizeFlag:UsePyConfig.optimization_levelorPyConfig_Get("optimization_level")instead.Py_NoSiteFlag:UsePyConfig.site_importorPyConfig_Get("site_import")instead.Py_BytesWarningFlag:UsePyConfig.bytes_warningorPyConfig_Get("bytes_warning")instead.Py_FrozenFlag:UsePyConfig.pathconfig_warningsorPyConfig_Get("pathconfig_warnings")instead.Py_IgnoreEnvironmentFlag:UsePyConfig.use_environmentorPyConfig_Get("use_environment")instead.Py_DontWriteBytecodeFlag:UsePyConfig.write_bytecodeorPyConfig_Get("write_bytecode")instead.Py_NoUserSiteDirectory:UsePyConfig.user_site_directoryorPyConfig_Get("user_site_directory")instead.Py_UnbufferedStdioFlag:UsePyConfig.buffered_stdioorPyConfig_Get("buffered_stdio")instead.Py_HashRandomizationFlag:UsePyConfig.use_hash_seedandPyConfig.hash_seedorPyConfig_Get("hash_seed")instead.Py_IsolatedFlag:UsePyConfig.isolatedorPyConfig_Get("isolated")instead.Py_LegacyWindowsFSEncodingFlag:UsePyPreConfig.legacy_windows_fs_encodingorPyConfig_Get("legacy_windows_fs_encoding")instead.Py_LegacyWindowsStdioFlag:UsePyConfig.legacy_windows_stdioorPyConfig_Get("legacy_windows_stdio")instead.Py_FileSystemDefaultEncoding,Py_HasFileSystemDefaultEncoding:UsePyConfig.filesystem_encodingorPyConfig_Get("filesystem_encoding")instead.Py_FileSystemDefaultEncodeErrors:UsePyConfig.filesystem_errorsorPyConfig_Get("filesystem_errors")instead.Py_UTF8Mode:UsePyPreConfig.utf8_modeorPyConfig_Get("utf8_mode")instead.(seePy_PreInitialize())
The
Py_InitializeFromConfig()API should be used withPyConfigto set these options. OrPyConfig_Get()can beused to get these options at runtime.
Pending removal in Python 3.18¶
The following private functions are deprecatedand planned for removal in Python 3.18:
_PyBytes_Join(): usePyBytes_Join()._PyDict_GetItemStringWithError(): usePyDict_GetItemStringRef()._PyDict_Pop(): usePyDict_Pop()._PyLong_Sign(): usePyLong_GetSign()._PyLong_FromDigits()and_PyLong_New():usePyLongWriter_Create()._PyThreadState_UncheckedGet(): usePyThreadState_GetUnchecked()._PyUnicode_AsString(): usePyUnicode_AsUTF8()._PyUnicodeWriter_Init():replace_PyUnicodeWriter_Init(&writer)withwriter=PyUnicodeWriter_Create(0)._PyUnicodeWriter_Finish():replace_PyUnicodeWriter_Finish(&writer)withPyUnicodeWriter_Finish(writer)._PyUnicodeWriter_Dealloc():replace_PyUnicodeWriter_Dealloc(&writer)withPyUnicodeWriter_Discard(writer)._PyUnicodeWriter_WriteChar():replace_PyUnicodeWriter_WriteChar(&writer,ch)withPyUnicodeWriter_WriteChar(writer,ch)._PyUnicodeWriter_WriteStr():replace_PyUnicodeWriter_WriteStr(&writer,str)withPyUnicodeWriter_WriteStr(writer,str)._PyUnicodeWriter_WriteSubstring():replace_PyUnicodeWriter_WriteSubstring(&writer,str,start,end)withPyUnicodeWriter_WriteSubstring(writer,str,start,end)._PyUnicodeWriter_WriteASCIIString():replace_PyUnicodeWriter_WriteASCIIString(&writer,str)withPyUnicodeWriter_WriteASCII(writer,str)._PyUnicodeWriter_WriteLatin1String():replace_PyUnicodeWriter_WriteLatin1String(&writer,str)withPyUnicodeWriter_WriteUTF8(writer,str)._PyUnicodeWriter_Prepare(): (no replacement)._PyUnicodeWriter_PrepareKind(): (no replacement)._Py_HashPointer(): usePy_HashPointer()._Py_fopen_obj(): usePy_fopen().
Thepythoncapi-compat project can be used to getthese new public functions on Python 3.13 and older.(Contributed by Victor Stinner ingh-128863.)
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_GetRaisedException()instead.PyErr_NormalizeException():UsePyErr_GetRaisedException()instead.PyErr_Restore():UsePyErr_SetRaisedException()instead.PyModule_GetFilename():UsePyModule_GetFilenameObject()instead.PyOS_AfterFork():UsePyOS_AfterFork_Child()instead.PySlice_GetIndicesEx():UsePySlice_Unpack()andPySlice_AdjustIndices()instead.PyUnicode_READY():Unneeded since Python 3.12PyErr_Display():UsePyErr_DisplayException()instead._PyErr_ChainExceptions():Use_PyErr_ChainExceptions1()instead.PyBytesObject.ob_shashmember:callPyObject_Hash()instead.Thread Local Storage (TLS) API:
PyThread_create_key():UsePyThread_tss_alloc()instead.PyThread_delete_key():UsePyThread_tss_free()instead.PyThread_set_key_value():UsePyThread_tss_set()instead.PyThread_get_key_value():UsePyThread_tss_get()instead.PyThread_delete_key_value():UsePyThread_tss_delete()instead.PyThread_ReInitTLS():Unneeded since Python 3.7.