[Python-checkins] bpo-45434: Remove pystrhex.h header file (GH-28923)
vstinner
webhook-mailer at python.org
Wed Oct 13 09:22:44 EDT 2021
https://github.com/python/cpython/commit/bbe7497c5a44c2b4ec726605cf5a9086ba02daf1
commit: bbe7497c5a44c2b4ec726605cf5a9086ba02daf1
branch: main
author: Victor Stinner <vstinner at python.org>
committer: vstinner <vstinner at python.org>
date: 2021-10-13T15:22:35+02:00
summary:
bpo-45434: Remove pystrhex.h header file (GH-28923)
Move Include/pystrhex.h to Include/internal/pycore_strhex.h.
The header file only contains private functions.
The following C extensions are now built with Py_BUILD_CORE_MODULE
macro defined to get access to the internal C API:
* _blake2
* _hashopenssl
* _md5
* _sha1
* _sha3
* _ssl
* binascii
files:
A Include/internal/pycore_strhex.h
A Misc/NEWS.d/next/C API/2021-10-13-14-42-46.bpo-45434.INNEEt.rst
D Include/pystrhex.h
M Doc/whatsnew/3.11.rst
M Makefile.pre.in
M Modules/Setup
M Modules/_blake2/blake2b_impl.c
M Modules/_blake2/blake2s_impl.c
M Modules/_hashopenssl.c
M Modules/_sha3/sha3module.c
M Modules/binascii.c
M Modules/md5module.c
M Modules/sha1module.c
M Modules/sha256module.c
M Modules/sha512module.c
M Objects/bytearrayobject.c
M Objects/bytesobject.c
M Objects/memoryobject.c
M PCbuild/pythoncore.vcxproj
M PCbuild/pythoncore.vcxproj.filters
M Python/pystrhex.c
M setup.py
diff --git a/Doc/whatsnew/3.11.rst b/Doc/whatsnew/3.11.rst
index 21a46b4b72133..21a0e1ab9c693 100644
--- a/Doc/whatsnew/3.11.rst
+++ b/Doc/whatsnew/3.11.rst
@@ -598,3 +598,7 @@ Removed
since Python 3.3. Use ``PyUnicode_CopyCharacters()`` or ``memcpy()``
(``wchar_t*`` string), and ``PyUnicode_Fill()`` functions instead.
(Contributed by Victor Stinner in :issue:`41123`.)
+
+* Remove the ``pystrhex.h`` header file. It only contains private functions.
+ C extensions should only include the main ``<Python.h>`` header file.
+ (Contributed by Victor Stinner in :issue:`45434`.)
diff --git a/Include/internal/pycore_strhex.h b/Include/internal/pycore_strhex.h
new file mode 100644
index 0000000000000..1633671da0f4c
--- /dev/null
+++ b/Include/internal/pycore_strhex.h
@@ -0,0 +1,36 @@
+#ifndef Py_INTERNAL_STRHEX_H
+#define Py_INTERNAL_STRHEX_H
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#ifndef Py_BUILD_CORE
+# error "this header requires Py_BUILD_CORE define"
+#endif
+
+// Returns a str() containing the hex representation of argbuf.
+PyAPI_FUNC(PyObject*) _Py_strhex(const
+ char* argbuf,
+ const Py_ssize_t arglen);
+
+// Returns a bytes() containing the ASCII hex representation of argbuf.
+PyAPI_FUNC(PyObject*) _Py_strhex_bytes(
+ const char* argbuf,
+ const Py_ssize_t arglen);
+
+// These variants include support for a separator between every N bytes:
+PyAPI_FUNC(PyObject*) _Py_strhex_with_sep(
+ const char* argbuf,
+ const Py_ssize_t arglen,
+ const PyObject* sep,
+ const int bytes_per_group);
+PyAPI_FUNC(PyObject*) _Py_strhex_bytes_with_sep(
+ const char* argbuf,
+ const Py_ssize_t arglen,
+ const PyObject* sep,
+ const int bytes_per_group);
+
+#ifdef __cplusplus
+}
+#endif
+#endif /* !Py_INTERNAL_STRHEX_H */
diff --git a/Include/pystrhex.h b/Include/pystrhex.h
deleted file mode 100644
index a4f36305bac69..0000000000000
--- a/Include/pystrhex.h
+++ /dev/null
@@ -1,22 +0,0 @@
-#ifndef Py_STRHEX_H
-#define Py_STRHEX_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#ifndef Py_LIMITED_API
-/* Returns a str() containing the hex representation of argbuf. */
-PyAPI_FUNC(PyObject*) _Py_strhex(const char* argbuf, const Py_ssize_t arglen);
-/* Returns a bytes() containing the ASCII hex representation of argbuf. */
-PyAPI_FUNC(PyObject*) _Py_strhex_bytes(const char* argbuf, const Py_ssize_t arglen);
-/* These variants include support for a separator between every N bytes: */
-PyAPI_FUNC(PyObject*) _Py_strhex_with_sep(const char* argbuf, const Py_ssize_t arglen, const PyObject* sep, const int bytes_per_group);
-PyAPI_FUNC(PyObject*) _Py_strhex_bytes_with_sep(const char* argbuf, const Py_ssize_t arglen, const PyObject* sep, const int bytes_per_group);
-#endif /* !Py_LIMITED_API */
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* !Py_STRHEX_H */
diff --git a/Makefile.pre.in b/Makefile.pre.in
index 4d4076f388260..041bc63e2fb8e 100644
--- a/Makefile.pre.in
+++ b/Makefile.pre.in
@@ -1179,7 +1179,6 @@ PYTHON_HEADERS= \
$(srcdir)/Include/pyport.h \
$(srcdir)/Include/pystate.h \
$(srcdir)/Include/pystrcmp.h \
- $(srcdir)/Include/pystrhex.h \
$(srcdir)/Include/pystrtod.h \
$(srcdir)/Include/pythonrun.h \
$(srcdir)/Include/pythread.h \
@@ -1271,6 +1270,7 @@ PYTHON_HEADERS= \
$(srcdir)/Include/internal/pycore_pymem.h \
$(srcdir)/Include/internal/pycore_pystate.h \
$(srcdir)/Include/internal/pycore_runtime.h \
+ $(srcdir)/Include/internal/pycore_strhex.h \
$(srcdir)/Include/internal/pycore_structseq.h \
$(srcdir)/Include/internal/pycore_symtable.h \
$(srcdir)/Include/internal/pycore_sysmodule.h \
diff --git a/Misc/NEWS.d/next/C API/2021-10-13-14-42-46.bpo-45434.INNEEt.rst b/Misc/NEWS.d/next/C API/2021-10-13-14-42-46.bpo-45434.INNEEt.rst
new file mode 100644
index 0000000000000..933f80670f1ae
--- /dev/null
+++ b/Misc/NEWS.d/next/C API/2021-10-13-14-42-46.bpo-45434.INNEEt.rst
@@ -0,0 +1,3 @@
+Remove the ``pystrhex.h`` header file. It only contains private functions. C
+extensions should only include the main ``<Python.h>`` header file. Patch by
+Victor Stinner.
diff --git a/Modules/Setup b/Modules/Setup
index 5e26472446677..ba8c154ee4586 100644
--- a/Modules/Setup
+++ b/Modules/Setup
@@ -212,19 +212,23 @@ _symtable symtablemodule.c
# OPENSSL=/path/to/openssl/directory
# _ssl _ssl.c \
# -I$(OPENSSL)/include -L$(OPENSSL)/lib \
-# -lssl -lcrypto
+# -lssl -lcrypto \
+# -DPy_BUILD_CORE_BUILTIN
#_hashlib _hashopenssl.c \
# -I$(OPENSSL)/include -L$(OPENSSL)/lib \
-# -lcrypto
+# -lcrypto \
+# -DPy_BUILD_CORE_BUILTIN
# To statically link OpenSSL:
# _ssl _ssl.c \
# -I$(OPENSSL)/include -L$(OPENSSL)/lib \
# -l:libssl.a -Wl,--exclude-libs,libssl.a \
-# -l:libcrypto.a -Wl,--exclude-libs,libcrypto.a
+# -l:libcrypto.a -Wl,--exclude-libs,libcrypto.a \
+# -DPy_BUILD_CORE_BUILTIN
#_hashlib _hashopenssl.c \
# -I$(OPENSSL)/include -L$(OPENSSL)/lib \
-# -l:libcrypto.a -Wl,--exclude-libs,libcrypto.a
+# -l:libcrypto.a -Wl,--exclude-libs,libcrypto.a \
+# -DPy_BUILD_CORE_BUILTIN
# The crypt module is now disabled by default because it breaks builds
# on many systems (where -lcrypt is needed), e.g. Linux (I believe).
@@ -255,18 +259,18 @@ _symtable symtablemodule.c
# The _md5 module implements the RSA Data Security, Inc. MD5
# Message-Digest Algorithm, described in RFC 1321.
-#_md5 md5module.c
+#_md5 md5module.c -DPy_BUILD_CORE_BUILTIN
# The _sha module implements the SHA checksum algorithms.
# (NIST's Secure Hash Algorithms.)
-#_sha1 sha1module.c
+#_sha1 sha1module.c -DPy_BUILD_CORE_BUILTIN
#_sha256 sha256module.c -DPy_BUILD_CORE_BUILTIN
#_sha512 sha512module.c -DPy_BUILD_CORE_BUILTIN
-#_sha3 _sha3/sha3module.c
+#_sha3 _sha3/sha3module.c -DPy_BUILD_CORE_BUILTIN
# _blake module
-#_blake2 _blake2/blake2module.c _blake2/blake2b_impl.c _blake2/blake2s_impl.c
+#_blake2 _blake2/blake2module.c _blake2/blake2b_impl.c _blake2/blake2s_impl.c -DPy_BUILD_CORE_BUILTIN
# The _tkinter module.
#
@@ -339,7 +343,7 @@ _symtable symtablemodule.c
# Helper module for various ascii-encoders
-#binascii binascii.c
+#binascii binascii.c -DPy_BUILD_CORE_MODULE
# Andrew Kuchling's zlib module.
# This require zlib 1.1.3 (or later).
diff --git a/Modules/_blake2/blake2b_impl.c b/Modules/_blake2/blake2b_impl.c
index 8b0d60d02ac7c..b16324e8f7aeb 100644
--- a/Modules/_blake2/blake2b_impl.c
+++ b/Modules/_blake2/blake2b_impl.c
@@ -14,7 +14,7 @@
*/
#include "Python.h"
-#include "pystrhex.h"
+#include "pycore_strhex.h" // _Py_strhex()
#include "../hashlib.h"
#include "blake2ns.h"
diff --git a/Modules/_blake2/blake2s_impl.c b/Modules/_blake2/blake2s_impl.c
index 7ab3917aa1a65..6b31a363ea27b 100644
--- a/Modules/_blake2/blake2s_impl.c
+++ b/Modules/_blake2/blake2s_impl.c
@@ -14,7 +14,7 @@
*/
#include "Python.h"
-#include "pystrhex.h"
+#include "pycore_strhex.h" // _Py_strhex()
#include "../hashlib.h"
#include "blake2ns.h"
diff --git a/Modules/_hashopenssl.c b/Modules/_hashopenssl.c
index b9e68c05c3edb..b4ba60baaac93 100644
--- a/Modules/_hashopenssl.c
+++ b/Modules/_hashopenssl.c
@@ -22,7 +22,7 @@
#include "Python.h"
#include "hashlib.h"
-#include "pystrhex.h"
+#include "pycore_strhex.h" // _Py_strhex()
/* EVP is the preferred interface to hashing in OpenSSL */
#include <openssl/evp.h>
diff --git a/Modules/_sha3/sha3module.c b/Modules/_sha3/sha3module.c
index 3974e0b6b47fa..a033c4e452545 100644
--- a/Modules/_sha3/sha3module.c
+++ b/Modules/_sha3/sha3module.c
@@ -16,7 +16,7 @@
*/
#include "Python.h"
-#include "pystrhex.h"
+#include "pycore_strhex.h" // _Py_strhex()
#include "../hashlib.h"
/* **************************************************************************
diff --git a/Modules/binascii.c b/Modules/binascii.c
index db960dcdcb0b6..ef209881494ac 100644
--- a/Modules/binascii.c
+++ b/Modules/binascii.c
@@ -56,9 +56,9 @@
#define PY_SSIZE_T_CLEAN
#include "Python.h"
-#include "pystrhex.h"
+#include "pycore_strhex.h" // _Py_strhex_bytes_with_sep()
#ifdef USE_ZLIB_CRC32
-#include "zlib.h"
+# include "zlib.h"
#endif
typedef struct binascii_state {
diff --git a/Modules/md5module.c b/Modules/md5module.c
index b50d2e5b0bdb7..4d03f6b844b33 100644
--- a/Modules/md5module.c
+++ b/Modules/md5module.c
@@ -18,7 +18,7 @@
#include "Python.h"
#include "hashlib.h"
-#include "pystrhex.h"
+#include "pycore_strhex.h" // _Py_strhex()
/*[clinic input]
module _md5
diff --git a/Modules/sha1module.c b/Modules/sha1module.c
index d186aa460a07b..153bc12a8bd74 100644
--- a/Modules/sha1module.c
+++ b/Modules/sha1module.c
@@ -18,7 +18,7 @@
#include "Python.h"
#include "hashlib.h"
-#include "pystrhex.h"
+#include "pycore_strhex.h" // _Py_strhex()
/*[clinic input]
module _sha1
diff --git a/Modules/sha256module.c b/Modules/sha256module.c
index fac7073d951d2..5858071db4e13 100644
--- a/Modules/sha256module.c
+++ b/Modules/sha256module.c
@@ -18,9 +18,9 @@
#include "Python.h"
#include "pycore_bitutils.h" // _Py_bswap32()
+#include "pycore_strhex.h" // _Py_strhex()
#include "structmember.h" // PyMemberDef
#include "hashlib.h"
-#include "pystrhex.h"
/*[clinic input]
module _sha256
diff --git a/Modules/sha512module.c b/Modules/sha512module.c
index 4ea2fc16de052..e50b69be4617d 100644
--- a/Modules/sha512module.c
+++ b/Modules/sha512module.c
@@ -18,9 +18,9 @@
#include "Python.h"
#include "pycore_bitutils.h" // _Py_bswap64()
+#include "pycore_strhex.h" // _Py_strhex()
#include "structmember.h" // PyMemberDef
#include "hashlib.h"
-#include "pystrhex.h"
/*[clinic input]
module _sha512
diff --git a/Objects/bytearrayobject.c b/Objects/bytearrayobject.c
index 1ab9621b1f265..a6009854221ff 100644
--- a/Objects/bytearrayobject.c
+++ b/Objects/bytearrayobject.c
@@ -4,9 +4,9 @@
#include "Python.h"
#include "pycore_abstract.h" // _PyIndex_Check()
#include "pycore_bytes_methods.h"
-#include "pycore_object.h"
+#include "pycore_object.h" // _PyObject_GC_UNTRACK()
+#include "pycore_strhex.h" // _Py_strhex_with_sep()
#include "bytesobject.h"
-#include "pystrhex.h"
/*[clinic input]
class bytearray "PyByteArrayObject *" "&PyByteArray_Type"
diff --git a/Objects/bytesobject.c b/Objects/bytesobject.c
index bc0b075cf405b..1163cf00034b2 100644
--- a/Objects/bytesobject.c
+++ b/Objects/bytesobject.c
@@ -10,8 +10,8 @@
#include "pycore_initconfig.h" // _PyStatus_OK()
#include "pycore_object.h" // _PyObject_GC_TRACK
#include "pycore_pymem.h" // PYMEM_CLEANBYTE
+#include "pycore_strhex.h" // _Py_strhex_with_sep()
-#include "pystrhex.h"
#include <stddef.h>
/*[clinic input]
diff --git a/Objects/memoryobject.c b/Objects/memoryobject.c
index 913d358062219..6257455d34715 100644
--- a/Objects/memoryobject.c
+++ b/Objects/memoryobject.c
@@ -11,10 +11,10 @@
*/
#include "Python.h"
-#include "pycore_abstract.h" // _PyIndex_Check()
-#include "pycore_object.h"
-#include "pystrhex.h"
-#include <stddef.h>
+#include "pycore_abstract.h" // _PyIndex_Check()
+#include "pycore_object.h" // _PyObject_GC_UNTRACK()
+#include "pycore_strhex.h" // _Py_strhex_with_sep()
+#include <stddef.h> // offsetof()
/*[clinic input]
class memoryview "PyMemoryViewObject *" "&PyMemoryView_Type"
diff --git a/PCbuild/pythoncore.vcxproj b/PCbuild/pythoncore.vcxproj
index b8cadf469355f..d0e1b52a4927c 100644
--- a/PCbuild/pythoncore.vcxproj
+++ b/PCbuild/pythoncore.vcxproj
@@ -209,6 +209,7 @@
<ClInclude Include="..\Include\internal\pycore_pymem.h" />
<ClInclude Include="..\Include\internal\pycore_pystate.h" />
<ClInclude Include="..\Include\internal\pycore_runtime.h" />
+ <ClInclude Include="..\Include\internal\pycore_strhex.h" />
<ClInclude Include="..\Include\internal\pycore_structseq.h" />
<ClInclude Include="..\Include\internal\pycore_sysmodule.h" />
<ClInclude Include="..\Include\internal\pycore_symtable.h" />
@@ -248,7 +249,6 @@
<ClInclude Include="..\Include\pyport.h" />
<ClInclude Include="..\Include\pystate.h" />
<ClInclude Include="..\Include\pystrcmp.h" />
- <ClInclude Include="..\Include\pystrhex.h" />
<ClInclude Include="..\Include\pystrtod.h" />
<ClInclude Include="..\Include\pythonrun.h" />
<ClInclude Include="..\Include\pythread.h" />
diff --git a/PCbuild/pythoncore.vcxproj.filters b/PCbuild/pythoncore.vcxproj.filters
index 4eccf4f43d1ad..9370f405132c3 100644
--- a/PCbuild/pythoncore.vcxproj.filters
+++ b/PCbuild/pythoncore.vcxproj.filters
@@ -201,9 +201,6 @@
<ClInclude Include="..\Include\pystrtod.h">
<Filter>Include</Filter>
</ClInclude>
- <ClInclude Include="..\Include\pystrhex.h">
- <Filter>Include</Filter>
- </ClInclude>
<ClInclude Include="..\Include\Python.h">
<Filter>Include</Filter>
</ClInclude>
@@ -588,6 +585,9 @@
<ClInclude Include="..\Include\internal\pycore_runtime.h">
<Filter>Include\internal</Filter>
</ClInclude>
+ <ClInclude Include="..\Include\internal\pycore_strhex.h">
+ <Filter>Include\internal</Filter>
+ </ClInclude>
<ClInclude Include="..\Include\internal\pycore_sysmodule.h">
<Filter>Include\internal</Filter>
</ClInclude>
diff --git a/Python/pystrhex.c b/Python/pystrhex.c
index b74e57ad913b1..f7fe3b6eb85d0 100644
--- a/Python/pystrhex.c
+++ b/Python/pystrhex.c
@@ -1,8 +1,8 @@
-/* bytes to hex implementation */
+/* Format bytes as hexadecimal */
#include "Python.h"
+#include "pycore_strhex.h" // _Py_strhex_with_sep()
-#include "pystrhex.h"
static PyObject *_Py_strhex_impl(const char* argbuf, const Py_ssize_t arglen,
const PyObject* sep, int bytes_per_sep_group,
diff --git a/setup.py b/setup.py
index 039c96b0e4d7b..56c06cbddaf21 100644
--- a/setup.py
+++ b/setup.py
@@ -1709,12 +1709,12 @@ def detect_compress_exts(self):
# Helper module for various ascii-encoders. Uses zlib for an optimized
# crc32 if we have it. Otherwise binascii uses its own.
+ extra_compile_args = ['-DPy_BUILD_CORE_MODULE']
if have_zlib:
- extra_compile_args = ['-DUSE_ZLIB_CRC32']
+ extra_compile_args.append('-DUSE_ZLIB_CRC32')
libraries = ['z']
extra_link_args = zlib_extra_link_args
else:
- extra_compile_args = []
libraries = []
extra_link_args = []
self.add(Extension('binascii', ['binascii.c'],
@@ -2469,6 +2469,7 @@ def split_var(name, sep):
library_dirs=openssl_libdirs,
libraries=openssl_libs,
runtime_library_dirs=runtime_library_dirs,
+ extra_compile_args=['-DPy_BUILD_CORE_MODULE'],
)
# This static linking is NOT OFFICIALLY SUPPORTED.
@@ -2530,27 +2531,29 @@ def detect_hash_builtins(self):
if "sha256" in configured:
self.add(Extension(
'_sha256', ['sha256module.c'],
+ depends=['hashlib.h'],
extra_compile_args=['-DPy_BUILD_CORE_MODULE'],
- depends=['hashlib.h']
))
if "sha512" in configured:
self.add(Extension(
'_sha512', ['sha512module.c'],
+ depends=['hashlib.h'],
extra_compile_args=['-DPy_BUILD_CORE_MODULE'],
- depends=['hashlib.h']
))
if "md5" in configured:
self.add(Extension(
'_md5', ['md5module.c'],
- depends=['hashlib.h']
+ depends=['hashlib.h'],
+ extra_compile_args=['-DPy_BUILD_CORE_MODULE'],
))
if "sha1" in configured:
self.add(Extension(
'_sha1', ['sha1module.c'],
- depends=['hashlib.h']
+ depends=['hashlib.h'],
+ extra_compile_args=['-DPy_BUILD_CORE_MODULE'],
))
if "blake2" in configured:
@@ -2565,7 +2568,8 @@ def detect_hash_builtins(self):
'_blake2/blake2b_impl.c',
'_blake2/blake2s_impl.c'
],
- depends=blake2_deps
+ depends=blake2_deps,
+ extra_compile_args=['-DPy_BUILD_CORE_MODULE'],
))
if "sha3" in configured:
@@ -2576,7 +2580,8 @@ def detect_hash_builtins(self):
self.add(Extension(
'_sha3',
['_sha3/sha3module.c'],
- depends=sha3_deps
+ depends=sha3_deps,
+ extra_compile_args=['-DPy_BUILD_CORE_MODULE'],
))
def detect_nis(self):
More information about the Python-checkins
mailing list