]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
bpo-46541: Replace core use of _Py_IDENTIFIER() with statically initialized global...
authorEric Snow <ericsnowcurrently@gmail.com>
Tue, 8 Feb 2022 20:39:07 +0000 (13:39 -0700)
committerGitHub <noreply@github.com>
Tue, 8 Feb 2022 20:39:07 +0000 (13:39 -0700)
commit81c72044a181dbbfbf689d7a977d0d99090f26a8
tree14329746bd6f179cf2ae7c9818e1ae881eb46360
parentc018d3037b5b62e6d48d5985d1a37b91762fbffb
bpo-46541: Replace core use of _Py_IDENTIFIER() with statically initialized global objects. (gh-30928)

We're no longer using _Py_IDENTIFIER() (or _Py_static_string()) in any core CPython code.  It is still used in a number of non-builtin stdlib modules.

The replacement is: PyUnicodeObject (not pointer) fields under _PyRuntimeState, statically initialized as part of _PyRuntime.  A new _Py_GET_GLOBAL_IDENTIFIER() macro facilitates lookup of the fields (along with _Py_GET_GLOBAL_STRING() for non-identifier strings).

https://bugs.python.org/issue46541#msg411799 explains the rationale for this change.

The core of the change is in:

* (new) Include/internal/pycore_global_strings.h - the declarations for the global strings, along with the macros
* Include/internal/pycore_runtime_init.h - added the static initializers for the global strings
* Include/internal/pycore_global_objects.h - where the struct in pycore_global_strings.h is hooked into _PyRuntimeState
* Tools/scripts/generate_global_objects.py - added generation of the global string declarations and static initializers

I've also added a --check flag to generate_global_objects.py (along with make check-global-objects) to check for unused global strings.  That check is added to the PR CI config.

The remainder of this change updates the core code to use _Py_GET_GLOBAL_IDENTIFIER() instead of _Py_IDENTIFIER() and the related _Py*Id functions (likewise for _Py_GET_GLOBAL_STRING() instead of _Py_static_string()).  This includes adding a few functions where there wasn't already an alternative to _Py*Id(), replacing the _Py_Identifier * parameter with PyObject *.

The following are not changed (yet):

* stop using _Py_IDENTIFIER() in the stdlib modules
* (maybe) get rid of _Py_IDENTIFIER(), etc. entirely -- this may not be doable as at least one package on PyPI using this (private) API
* (maybe) intern the strings during runtime init

https://bugs.python.org/issue46541
108 files changed:
.github/workflows/build.yml
Include/cpython/abstract.h
Include/cpython/ceval.h
Include/cpython/dictobject.h
Include/cpython/object.h
Include/cpython/sysmodule.h
Include/internal/pycore_call.h
Include/internal/pycore_global_objects.h
Include/internal/pycore_global_strings.h [new file with mode: 0644]
Include/internal/pycore_object.h
Include/internal/pycore_runtime_init.h
Include/internal/pycore_structseq.h
Include/internal/pycore_sysmodule.h
Include/internal/pycore_unicodeobject.h
Makefile.pre.in
Modules/_abc.c
Modules/_asynciomodule.c
Modules/_bisectmodule.c
Modules/_collectionsmodule.c
Modules/_csv.c
Modules/_ctypes/_ctypes.c
Modules/_ctypes/callbacks.c
Modules/_ctypes/callproc.c
Modules/_ctypes/stgdict.c
Modules/_cursesmodule.c
Modules/_datetimemodule.c
Modules/_dbmmodule.c
Modules/_elementtree.c
Modules/_gdbmmodule.c
Modules/_io/_iomodule.c
Modules/_io/bufferedio.c
Modules/_io/fileio.c
Modules/_io/iobase.c
Modules/_io/textio.c
Modules/_io/winconsoleio.c
Modules/_json.c
Modules/_lzmamodule.c
Modules/_operator.c
Modules/_pickle.c
Modules/_sqlite/connection.c
Modules/_sqlite/cursor.c
Modules/_sqlite/microprotocols.c
Modules/_sqlite/module.c
Modules/_ssl.c
Modules/_testcapimodule.c
Modules/_threadmodule.c
Modules/arraymodule.c
Modules/cjkcodecs/multibytecodec.c
Modules/faulthandler.c
Modules/itertoolsmodule.c
Modules/main.c
Modules/mathmodule.c
Modules/mmapmodule.c
Modules/ossaudiodev.c
Modules/posixmodule.c
Modules/pyexpat.c
Modules/timemodule.c
Modules/unicodedata.c
Objects/abstract.c
Objects/bytearrayobject.c
Objects/bytesobject.c
Objects/call.c
Objects/classobject.c
Objects/complexobject.c
Objects/descrobject.c
Objects/dictobject.c
Objects/enumobject.c
Objects/exceptions.c
Objects/fileobject.c
Objects/frameobject.c
Objects/funcobject.c
Objects/genericaliasobject.c
Objects/genobject.c
Objects/iterobject.c
Objects/listobject.c
Objects/longobject.c
Objects/methodobject.c
Objects/moduleobject.c
Objects/object.c
Objects/odictobject.c
Objects/rangeobject.c
Objects/setobject.c
Objects/structseq.c
Objects/tupleobject.c
Objects/typeobject.c
Objects/unicodeobject.c
Objects/unionobject.c
Objects/weakrefobject.c
Parser/tokenizer.c
Programs/_testembed.c
Programs/test_frozenmain.h
Python/_warnings.c
Python/ast_opt.c
Python/bltinmodule.c
Python/ceval.c
Python/codecs.c
Python/compile.c
Python/errors.c
Python/import.c
Python/importdl.c
Python/marshal.c
Python/pylifecycle.c
Python/pythonrun.c
Python/specialize.c
Python/sysmodule.c
Python/traceback.c
Tools/c-analyzer/TODO
Tools/scripts/generate_global_objects.py