Files

142 lines
4.2 KiB
Python

# gh-91321: Build a basic C test extension to check that the Python C API is
# compatible with C and does not emit C compiler warnings.
import os
import shlex
import sys
import sysconfig
from test import support
from setuptools import setup, Extension
SOURCE = 'extension.c'
if not support.MS_WINDOWS:
# C compiler flags for GCC and clang
BASE_CFLAGS = [
# The purpose of test_cext extension is to check that building a C
# extension using the Python C API does not emit C compiler warnings.
'-Werror',
# Enable extra checks for header files, which:
# - need to be enabled somewhere inside Python headers (rather than
# before including Python.h)
# - should not be checked for user code
'-D_Py_IS_TESTCEXT',
]
# C compiler flags for GCC and clang
PUBLIC_CFLAGS = [
*BASE_CFLAGS,
# gh-120593: Check the 'const' qualifier
'-Wcast-qual',
# Ask for strict(er) compliance with the standard
'-pedantic-errors',
]
if not support.Py_GIL_DISABLED:
PUBLIC_CFLAGS.append(
# gh-116869: The Python C API must be compatible with building
# with the -Werror=declaration-after-statement compiler flag.
'-Werror=declaration-after-statement',
)
INTERNAL_CFLAGS = [*BASE_CFLAGS]
else:
# MSVC compiler flags
BASE_CFLAGS = [
# Treat all compiler warnings as compiler errors
'/WX',
]
PUBLIC_CFLAGS = [
*BASE_CFLAGS,
# Display warnings level 1 to 4
'/W4',
]
INTERNAL_CFLAGS = [
*BASE_CFLAGS,
# Display warnings level 1 to 3
'/W3',
]
def main():
std = os.environ.get("CPYTHON_TEST_STD", "")
module_name = os.environ["CPYTHON_TEST_EXT_NAME"]
limited = bool(os.environ.get("CPYTHON_TEST_LIMITED", ""))
abi3t = bool(os.environ.get("CPYTHON_TEST_ABI3T", ""))
internal = bool(int(os.environ.get("TEST_INTERNAL_C_API", "0")))
incdirs = os.environ.get("CPYTHON_EXTRA_INCDIRS", "")
libdirs = os.environ.get("CPYTHON_EXTRA_LIBDIRS", "")
sources = [SOURCE]
if not internal:
cflags = list(PUBLIC_CFLAGS)
else:
cflags = list(INTERNAL_CFLAGS)
cflags.append(f'-DMODULE_NAME={module_name}')
# Add -std=STD or /std:STD (MSVC) compiler flag
if std:
if support.MS_WINDOWS:
cflags.append(f'/std:{std}')
else:
cflags.append(f'-std={std}')
# Remove existing -std or /std options from CC command line.
# Python adds -std=c11 option.
cmd = (sysconfig.get_config_var('CC') or '')
if cmd is not None:
if support.MS_WINDOWS:
std_prefix = '/std'
else:
std_prefix = '-std'
cmd = shlex.split(cmd)
cmd = [arg for arg in cmd if not arg.startswith(std_prefix)]
cmd = shlex.join(cmd)
# CC env var overrides sysconfig CC variable in setuptools
os.environ['CC'] = cmd
# Define opt-in macros
if limited:
cflags.append(f'-DPy_LIMITED_API={sys.hexversion:#x}')
if abi3t:
cflags.append(f'-DPy_TARGET_ABI3T={sys.hexversion:#x}')
if internal:
cflags.append('-DTEST_INTERNAL_C_API=1')
# Add additional include and library directories, typically for in-tree
# testing where not all directories are inferred
include_dirs = []
library_dirs = []
if incdirs:
print("Add incdirs:", incdirs)
include_dirs.extend(incdirs.split(os.pathsep))
if libdirs:
print("Add libdirs:", libdirs)
library_dirs.extend(libdirs.split(os.pathsep))
# Display information to help debugging
for env_name in ('CC', 'CFLAGS', 'CPPFLAGS'):
if env_name in os.environ:
print(f"{env_name} env var: {os.environ[env_name]!r}")
else:
print(f"{env_name} env var: <missing>")
print(f"extra_compile_args: {cflags!r}")
ext = Extension(
module_name,
sources=sources,
extra_compile_args=cflags,
include_dirs=include_dirs,
library_dirs=library_dirs)
setup(name=f'internal_{module_name}',
version='0.0',
ext_modules=[ext])
if __name__ == "__main__":
main()