Files
packages/lang/python/python3-package.mk
Daniel F. Dickinson 4cb00fd5fb python3: error on host python path too long
Error if shebang to host python interpreter would exceed 127 characters
(124 characters plus shebang and newline). This is used to alert user
when python-installer would fail to correctly set a Python program's
shebang line.

Closes: https://github.com/openwrt/packages/issues/28310

Signed-off-by: Daniel F. Dickinson <dfdpublic@wildtechgarden.ca>
2026-01-26 09:16:08 +02:00

313 lines
9.0 KiB
Makefile

#
# Copyright (C) 2007-2016 OpenWrt.org
#
# This is free software, licensed under the GNU General Public License v2.
# See /LICENSE for more information.
#
# Note: include this file after `include $(TOPDIR)/rules.mk in your package Makefile
python3_mk_path:=$(dir $(lastword $(MAKEFILE_LIST)))
include $(python3_mk_path)python3-host.mk
PYTHON3_DIR:=$(STAGING_DIR)/usr
PYTHON3_INC_DIR:=$(PYTHON3_DIR)/include/python$(PYTHON3_VERSION)
PYTHON3_LIB_DIR:=$(PYTHON3_DIR)/lib/python$(PYTHON3_VERSION)
PYTHON3_PKG_DIR:=/usr/lib/python$(PYTHON3_VERSION)/site-packages
PYTHON3:=python$(PYTHON3_VERSION)
PYTHON3PATH:=$(PYTHON3_LIB_DIR):$(STAGING_DIR)/$(PYTHON3_PKG_DIR):$(PKG_INSTALL_DIR)/$(PYTHON3_PKG_DIR)
-include $(PYTHON3_LIB_DIR)/openwrt/Makefile-vars
# Error if shebang to host python interpreter would exceed 127 characters
# (124 characters plus shebang and newline)
# This is used to alert user when python-installer would fail to correctly
# set a Python program's shebang line.
# See https://github.com/openwrt/packages/issues/28310
PYTHON3_PKG_HOST_BIN_MAX_PATH_LEN:=124
define CheckHostPythonShebang
set -e; \
HOST_PYTHON3_BIN="$(HOST_PYTHON3_BIN)"; \
if \
[ $$$${#HOST_PYTHON3_BIN} -gt $(PYTHON3_PKG_HOST_BIN_MAX_PATH_LEN) ]; then \
echo >&2 "Path to host python too long; python program install would fail";\
exit 1; \
fi
endef
# These configure args are needed in detection of path to Python header files
# using autotools.
CONFIGURE_ARGS += \
_python_sysroot="$(STAGING_DIR)" \
_python_prefix="/usr" \
_python_exec_prefix="/usr"
PYTHON3_VARS = \
CC="$(TARGET_CC)" \
CCSHARED="$(TARGET_CC) $(FPIC)" \
CXX="$(TARGET_CXX)" \
LD="$(TARGET_CC)" \
LDSHARED="$(TARGET_CC) -shared" \
CFLAGS="$(TARGET_CFLAGS)" \
CPPFLAGS="$(TARGET_CPPFLAGS) -I$(PYTHON3_INC_DIR)" \
LDFLAGS="$(TARGET_LDFLAGS) -lpython$(PYTHON3_VERSION)" \
_PYTHON_HOST_PLATFORM="$(_PYTHON_HOST_PLATFORM)" \
_PYTHON_SYSCONFIGDATA_NAME="_sysconfigdata_$(ABIFLAGS)_$(MACHDEP)_$(MULTIARCH)" \
PYTHONPATH="$(PYTHON3PATH)" \
PYTHONDONTWRITEBYTECODE=1 \
_python_sysroot="$(STAGING_DIR)" \
_python_prefix="/usr" \
_python_exec_prefix="/usr" \
$(CARGO_PKG_CONFIG_VARS) \
PYO3_CROSS_LIB_DIR="$(PYTHON3_LIB_DIR)" \
SETUPTOOLS_RUST_CARGO_PROFILE="$(CARGO_PKG_PROFILE)"
# $(1) => directory of python script
# $(2) => python script and its arguments
# $(3) => additional variables
define Python3/Run
cd "$(if $(strip $(1)),$(strip $(1)),.)" && \
$(PYTHON3_VARS) \
$(3) \
$(HOST_PYTHON3_BIN) $(2)
endef
define Python3/FixShebang
$(SED) "1"'!'"b;s,^#"'!'".*python.*,#"'!'"/usr/bin/python3," -i --follow-symlinks $(1)
endef
# default max recursion is 10
PYTHON3_COMPILEALL_MAX_RECURSION_LEVEL:=20
# $(1) => directory of python source files to compile
#
# XXX [So that you won't goof as I did]
# Note: Yes, I tried to use the -O & -OO flags here.
# However the generated byte-codes were not portable.
# So, we just stuck to un-optimized byte-codes,
# which is still way better/faster than running
# Python sources all the time.
#
# Setting a fixed hash seed value is less secure than using
# random seed values, but is necessary for reproducible builds
# (for now).
#
# Should revisit this when https://bugs.python.org/issue37596
# (and other related reproducibility issues) are fixed.
define Python3/CompileAll
$(call Python3/Run,, \
-m compileall -r "$(PYTHON3_COMPILEALL_MAX_RECURSION_LEVEL)" -b -d '/' $(1),
$(if $(SOURCE_DATE_EPOCH),PYTHONHASHSEED="$(SOURCE_DATE_EPOCH)")
)
endef
# $(1) => target directory
define Python3/DeleteSourceFiles
$(FIND) $(1) -type f -name '*.py' -delete
endef
# $(1) => target directory
define Python3/DeleteNonSourceFiles
$(FIND) $(1) -not -type d -not -name '*.py' -delete
endef
# $(1) => target directory
define Python3/DeleteEmptyDirs
$(FIND) $(1) -mindepth 1 -empty -type d -not -path '$(1)/CONTROL' -not -path '$(1)/CONTROL/*' -delete
endef
# Py3Package
define Py3Package/filespec/Default
+|$(PYTHON3_PKG_DIR)
endef
# $(1) => package name
# $(2) => src directory
# $(3) => dest directory
define Py3Package/ProcessFilespec
$(eval $(call shexport,Py3Package/$(1)/filespec))
$(SHELL) $(python3_mk_path)python-package-install.sh \
"$(2)" "$(3)" "$$$$$(call shvar,Py3Package/$(1)/filespec)"
endef
define Py3Package
define Package/$(1)-src
$(call Package/$(1))
DEPENDS:=
CONFLICTS:=
PROVIDES:=
EXTRA_DEPENDS:=
TITLE+= (sources)
USERID:=
MENU:=
endef
define Package/$(1)-src/description
$$(call Package/$(1)/description)
This package contains the Python source files for $(1).
endef
define Package/$(1)-src/config
depends on PACKAGE_$(1)
endef
# Add default PyPackage filespec none defined
ifeq ($(origin Py3Package/$(1)/filespec),undefined)
Py3Package/$(1)/filespec=$$(Py3Package/filespec/Default)
endif
ifndef Py3Package/$(1)/install
define Py3Package/$(1)/install
if [ -d $(PKG_INSTALL_DIR)/usr/bin ]; then \
$(INSTALL_DIR) $$(1)/usr/bin ; \
$(CP) $(PKG_INSTALL_DIR)/usr/bin/* $$(1)/usr/bin/ ; \
fi
endef
endif
ifndef Package/$(1)/install
define Package/$(1)/install
$$(call Py3Package/$(1)/install,$$(1))
$$(call Py3Package/ProcessFilespec,$(1),$(PKG_INSTALL_DIR),$$(1))
$(FIND) $$(1) -name '*.exe' -delete
$$(call Python3/CompileAll,$$(1))
$$(call Python3/DeleteSourceFiles,$$(1))
$$(call Python3/DeleteEmptyDirs,$$(1))
if [ -d "$$(1)/usr/bin" ]; then \
$$(call Python3/FixShebang,$$(1)/usr/bin/*) ; \
fi
endef
define Package/$(1)-src/install
$$(call Py3Package/$(1)/install,$$(1))
$$(call Py3Package/ProcessFilespec,$(1),$(PKG_INSTALL_DIR),$$(1))
$$(call Python3/DeleteNonSourceFiles,$$(1))
$$(call Python3/DeleteEmptyDirs,$$(1))
endef
endif # Package/$(1)/install
endef
# Py3Build
PYTHON3_PKG_BUILD?=1
PYTHON3_PKG_FORCE_DISTUTILS_SETUP?=
PYTHON3_PKG_SETUP_DIR?=
PYTHON3_PKG_SETUP_GLOBAL_ARGS?=
PYTHON3_PKG_SETUP_ARGS?=--single-version-externally-managed
PYTHON3_PKG_SETUP_VARS?=
PYTHON3_PKG_BUILD_CONFIG_SETTINGS?=
PYTHON3_PKG_BUILD_VARS?=$(PYTHON3_PKG_SETUP_VARS)
PYTHON3_PKG_BUILD_ARGS?=
PYTHON3_PKG_BUILD_PATH?=$(PYTHON3_PKG_SETUP_DIR)
PYTHON3_PKG_INSTALL_VARS?=
PYTHON3_PKG_WHEEL_NAME?=$(subst -,_,$(if $(PYPI_SOURCE_NAME),$(PYPI_SOURCE_NAME),$(PKG_NAME)))
PYTHON3_PKG_WHEEL_VERSION?=$(PKG_VERSION)
PYTHON3_PKG_BUILD_DIR?=$(PKG_BUILD_DIR)/$(PYTHON3_PKG_BUILD_PATH)
PYTHON3_PKG_HOST_PIP_INSTALL_ARGS = \
$(foreach req,$(HOST_PYTHON3_PACKAGE_BUILD_DEPENDS), \
--requirement \
$(if $(findstring /,$(req)),$(req),$(python3_mk_path)host-pip-requirements/$(req).txt) \
)
define Py3Build/FindStdlibDepends
$(SHELL) $(python3_mk_path)python3-find-stdlib-depends.sh -n "$(PKG_NAME)" "$(PKG_BUILD_DIR)";
endef
ifneq ($(strip $(PYPI_NAME)),)
define Py3Build/CheckHostPipVersionMatch
if [ -d "$(python3_mk_path)host-pip-requirements" ] && \
[ -n "$$$$($(FIND) $(python3_mk_path)host-pip-requirements -maxdepth 1 -mindepth 1 -name '*.txt' -print -quit 2>/dev/null)" ]; then \
if grep -q "$(PYPI_NAME)==" $(python3_mk_path)host-pip-requirements/*.txt ; then \
if ! grep -q "$(PYPI_NAME)==$(PKG_VERSION)" $(python3_mk_path)host-pip-requirements/*.txt ; then \
printf "\nPlease update version of $(PYPI_NAME) to $(PKG_VERSION) in 'host-pip-requirements'/\n\n" ; \
exit 1 ; \
fi \
fi \
fi
endef
endif
define Py3Build/InstallBuildDepends
$(if $(PYTHON3_PKG_HOST_PIP_INSTALL_ARGS), \
$(call HostPython3/PipInstall,$(PYTHON3_PKG_HOST_PIP_INSTALL_ARGS)) \
)
endef
define Py3Build/Compile/Distutils
$(call Py3Build/InstallBuildDepends)
$(INSTALL_DIR) $(PKG_INSTALL_DIR)/$(PYTHON3_PKG_DIR)
$(call Python3/Run, \
$(PKG_BUILD_DIR)/$(strip $(PYTHON3_PKG_SETUP_DIR)), \
setup.py \
$(PYTHON3_PKG_SETUP_GLOBAL_ARGS) \
install \
--prefix="/usr" \
--root="$(PKG_INSTALL_DIR)" \
$(PYTHON3_PKG_SETUP_ARGS) \
, \
$(PYTHON3_PKG_SETUP_VARS) \
)
endef
define Py3Build/Compile/Default
$(call Py3Build/InstallBuildDepends)
$(call Python3/Run, \
$(PKG_BUILD_DIR), \
-m build \
--no-isolation \
--outdir "$(PYTHON3_PKG_BUILD_DIR)"/openwrt-build \
--wheel \
$(foreach setting,$(PYTHON3_PKG_BUILD_CONFIG_SETTINGS),--config-setting=$(setting)) \
$(PYTHON3_PKG_BUILD_ARGS) \
"$(PYTHON3_PKG_BUILD_DIR)" \
, \
$(PYTHON3_PKG_BUILD_VARS) \
)
endef
define Py3Build/Install/Default
$(call CheckHostPythonShebang)
$(call Python3/Run, \
$(PKG_BUILD_DIR), \
-m installer \
--destdir "$(PKG_INSTALL_DIR)" \
--no-compile-bytecode \
--prefix /usr \
"$(PYTHON3_PKG_BUILD_DIR)"/openwrt-build/$(PYTHON3_PKG_WHEEL_NAME)-$(PYTHON3_PKG_WHEEL_VERSION)-*.whl \
, \
$(PYTHON3_PKG_INSTALL_VARS) \
)
endef
Py3Build/Compile=$(Py3Build/Compile/Default)
Py3Build/Install=$(Py3Build/Install/Default)
ifeq ($(strip $(PYTHON3_PKG_FORCE_DISTUTILS_SETUP)),1)
Py3Build/Compile=$(Py3Build/Compile/Distutils)
Py3Build/Install:=:
endif
ifeq ($(strip $(PYTHON3_PKG_BUILD)),1)
ifeq ($(PY3),stdlib)
Hooks/Configure/Post+=Py3Build/FindStdlibDepends
endif
Hooks/Configure/Post+=Py3Build/CheckHostPipVersionMatch
Build/Compile=$(Py3Build/Compile)
Build/Install=$(Py3Build/Install)
endif