diff options
Diffstat (limited to 'build_scripts/main.py')
| -rw-r--r-- | build_scripts/main.py | 1073 |
1 files changed, 577 insertions, 496 deletions
diff --git a/build_scripts/main.py b/build_scripts/main.py index 7239d328e..9a8d4fb3f 100644 --- a/build_scripts/main.py +++ b/build_scripts/main.py @@ -1,68 +1,60 @@ -############################################################################# -## -## Copyright (C) 2018 The Qt Company Ltd. -## Contact: https://www.qt.io/licensing/ -## -## This file is part of Qt for Python. -## -## $QT_BEGIN_LICENSE:LGPL$ -## Commercial License Usage -## Licensees holding valid commercial Qt licenses may use this file in -## accordance with the commercial license agreement provided with the -## Software or, alternatively, in accordance with the terms contained in -## a written agreement between you and The Qt Company. For licensing terms -## and conditions see https://www.qt.io/terms-conditions. For further -## information use the contact form at https://www.qt.io/contact-us. -## -## GNU Lesser General Public License Usage -## Alternatively, this file may be used under the terms of the GNU Lesser -## General Public License version 3 as published by the Free Software -## Foundation and appearing in the file LICENSE.LGPL3 included in the -## packaging of this file. Please review the following information to -## ensure the GNU Lesser General Public License version 3 requirements -## will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -## -## GNU General Public License Usage -## Alternatively, this file may be used under the terms of the GNU -## General Public License version 2.0 or (at your option) the GNU General -## Public license version 3 or any later version approved by the KDE Free -## Qt Foundation. The licenses are as published by the Free Software -## Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -## included in the packaging of this file. Please review the following -## information to ensure the GNU General Public License requirements will -## be met: https://www.gnu.org/licenses/gpl-2.0.html and -## https://www.gnu.org/licenses/gpl-3.0.html. -## -## $QT_END_LICENSE$ -## -############################################################################# - -from distutils.version import LooseVersion +# Copyright (C) 2018 The Qt Company Ltd. +# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only +import importlib import os import platform import re import sys -from textwrap import dedent +import sysconfig import time -from .config import config -from .utils import get_numpy_location, get_python_dict -from .options import DistUtilsCommandMixin, OPTION -from .versions import PYSIDE, PYSIDE_MODULE, SHIBOKEN -from .wheel_utils import (get_package_version, get_qt_version, - get_package_timestamp, macos_plat_name, - macos_pyside_min_deployment_target) +from packaging.version import parse as parse_version +from pathlib import Path +from shutil import copytree, rmtree +from textwrap import dedent + +# PYSIDE-1760: Pre-load setuptools modules early to avoid racing conditions. +# may be touched (should be avoided anyway, btw.) +# Note: This bug is only visible when tools like pyenv are not used. They have some +# pre-loading effect so that setuptools is already in the cache, hiding the problem. +from setuptools import Command, Extension +from setuptools.command.bdist_egg import bdist_egg as _bdist_egg +from setuptools.command.build_ext import build_ext as _build_ext +from setuptools.command.build_py import build_py as _build_py +from setuptools.command.build import build as _build +from setuptools.command.develop import develop as _develop +from setuptools.command.install import install as _install +from setuptools.command.install_lib import install_lib as _install_lib +from setuptools.command.install_scripts import install_scripts # noqa: preload only + +from .log import log, LogLevel +from setuptools.errors import SetupError +from .build_info_collector import BuildInfoCollectorMixin +from .config import config +from .options import OPTION, CommandMixin +from .platforms.unix import prepare_packages_posix +from .platforms.windows_desktop import prepare_packages_win32 +from .qtinfo import QtInfo +from .utils import (copydir, copyfile, detect_clang, + get_numpy_location, get_python_dict, + linux_fix_rpaths_for_library, macos_fix_rpaths_for_library, + platform_cmake_options, remove_tree, run_process, + run_process_output, update_env_path, which) +from . import PYSIDE, PYSIDE_MODULE, SHIBOKEN +from .wheel_override import get_bdist_wheel_override, wheel_module_exists +from .wheel_utils import (get_package_timestamp, get_package_version, + macos_plat_name, macos_pyside_min_deployment_target) -setup_script_dir = os.getcwd() -build_scripts_dir = os.path.join(setup_script_dir, 'build_scripts') -setup_py_path = os.path.join(setup_script_dir, "setup.py") +setup_script_dir = Path.cwd() +build_scripts_dir = setup_script_dir / 'build_scripts' +setup_py_path = setup_script_dir / "setup.py" -start_time = int(time.time()) +start_time = time.time() def elapsed(): - return int(time.time()) - start_time + return int(time.time() - start_time) def get_setuptools_extension_modules(): @@ -84,154 +76,46 @@ def _get_make(platform_arch, build_type): if makespec == "make": return ("make", "Unix Makefiles") if makespec == "msvc": - nmake_path = find_executable("nmake") - if nmake_path is None or not os.path.exists(nmake_path): - log.info("nmake not found. Trying to initialize the MSVC env...") - init_msvc_env(platform_arch, build_type) - nmake_path = find_executable("nmake") - if not nmake_path or not os.path.exists(nmake_path): - raise DistutilsSetupError('"nmake" could not be found.') if not OPTION["NO_JOM"]: - jom_path = find_executable("jom") + jom_path = Path(which("jom")) if jom_path: log.info(f"jom was found in {jom_path}") return (jom_path, "NMake Makefiles JOM") + nmake_path = Path(which("nmake")) + if nmake_path is None or not nmake_path.exists(): + raise SetupError("nmake not found") log.info(f"nmake was found in {nmake_path}") if OPTION["JOBS"]: msg = "Option --jobs can only be used with 'jom' on Windows." - raise DistutilsSetupError(msg) + raise SetupError(msg) return (nmake_path, "NMake Makefiles") if makespec == "mingw": - return ("mingw32-make", "mingw32-make") + return (Path("mingw32-make"), "mingw32-make") if makespec == "ninja": - return ("ninja", "Ninja") - raise DistutilsSetupError(f'Invalid option --make-spec "{makespec}".') + return (Path("ninja"), "Ninja") + raise SetupError(f'Invalid option --make-spec "{makespec}".') def get_make(platform_arch, build_type): """Retrieve the make command and CMake generator name""" (make_path, make_generator) = _get_make(platform_arch, build_type) - if not os.path.isabs(make_path): - found_path = find_executable(make_path) - if not found_path or not os.path.exists(found_path): - m = f"You need the program '{make_path}' on your system path to compile {PYSIDE_MODULE}." - raise DistutilsSetupError(m) + if not make_path.is_absolute(): + found_path = Path(which(make_path)) + if not found_path or not found_path.exists(): + m = (f"You need the program '{make_path}' on your system path to " + f"compile {PYSIDE_MODULE}.") + raise SetupError(m) make_path = found_path return (make_path, make_generator) -def _get_py_library_win(build_type, py_version, py_prefix, py_libdir, - py_include_dir): - """Helper for finding the Python library on Windows""" - if py_include_dir is None or not os.path.exists(py_include_dir): - py_include_dir = os.path.join(py_prefix, "include") - if py_libdir is None or not os.path.exists(py_libdir): - # For virtual environments on Windows, the py_prefix will contain a - # path pointing to it, instead of the system Python installation path. - # Since INCLUDEPY contains a path to the system location, we use the - # same base directory to define the py_libdir variable. - py_libdir = os.path.join(os.path.dirname(py_include_dir), "libs") - if not os.path.isdir(py_libdir): - raise DistutilsSetupError("Failed to locate the 'libs' directory") - dbg_postfix = "_d" if build_type == "Debug" else "" - if OPTION["MAKESPEC"] == "mingw": - static_lib_name = f"libpython{py_version.replace('.', '')}{dbg_postfix}.a" - return os.path.join(py_libdir, static_lib_name) - v = py_version.replace(".", "") - python_lib_name = f"python{v}{dbg_postfix}.lib" - return os.path.join(py_libdir, python_lib_name) - - -def _get_py_library_unix(build_type, py_version, py_prefix, py_libdir, - py_include_dir): - """Helper for finding the Python library on UNIX""" - if py_libdir is None or not os.path.exists(py_libdir): - py_libdir = os.path.join(py_prefix, "lib") - if py_include_dir is None or not os.path.exists(py_include_dir): - dir = f"include/python{py_version}" - py_include_dir = os.path.join(py_prefix, dir) - dbg_postfix = "_d" if build_type == "Debug" else "" - lib_exts = ['.so'] - if sys.platform == 'darwin': - lib_exts.append('.dylib') - lib_suff = getattr(sys, 'abiflags', None) - lib_exts.append('.so.1') - # Suffix for OpenSuSE 13.01 - lib_exts.append('.so.1.0') - # static library as last gasp - lib_exts.append('.a') - - libs_tried = [] - for lib_ext in lib_exts: - lib_name = f"libpython{py_version}{lib_suff}{lib_ext}" - py_library = os.path.join(py_libdir, lib_name) - if os.path.exists(py_library): - return py_library - libs_tried.append(py_library) - - # Try to find shared libraries which have a multi arch - # suffix. - py_multiarch = get_config_var("MULTIARCH") - if py_multiarch: - try_py_libdir = os.path.join(py_libdir, py_multiarch) - libs_tried = [] - for lib_ext in lib_exts: - lib_name = f"libpython{py_version}{lib_suff}{lib_ext}" - py_library = os.path.join(try_py_libdir, lib_name) - if os.path.exists(py_library): - return py_library - libs_tried.append(py_library) - - raise DistutilsSetupError(f"Failed to locate the Python library with {', '.join(libs_tried)}") - - -def get_py_library(build_type, py_version, py_prefix, py_libdir, py_include_dir): - """Find the Python library""" - if sys.platform == "win32": - py_library = _get_py_library_win(build_type, py_version, py_prefix, - py_libdir, py_include_dir) - else: - py_library = _get_py_library_unix(build_type, py_version, py_prefix, - py_libdir, py_include_dir) - if py_library.endswith('.a'): - # Python was compiled as a static library - log.error(f"Failed to locate a dynamic Python library, using {py_library}") - return py_library - - -import setuptools # Import setuptools before distutils -from setuptools import Extension -from setuptools.command.install import install as _install -from setuptools.command.install_lib import install_lib as _install_lib -from setuptools.command.bdist_egg import bdist_egg as _bdist_egg -from setuptools.command.develop import develop as _develop -from setuptools.command.build_py import build_py as _build_py - -import distutils.log as log -from distutils.errors import DistutilsSetupError -from distutils.sysconfig import get_config_var -from distutils.sysconfig import get_python_lib -from distutils.spawn import find_executable -from distutils.command.build import build as _build -from distutils.command.build_ext import build_ext as _build_ext -from distutils.cmd import Command - -from .qtinfo import QtInfo -from .utils import rmtree, detect_clang, copyfile, copydir, run_process_output, run_process -from .utils import update_env_path, init_msvc_env, filter_match -from .utils import macos_fix_rpaths_for_library -from .utils import linux_fix_rpaths_for_library -from .platforms.unix import prepare_packages_posix -from .platforms.windows_desktop import prepare_packages_win32 -from .wheel_override import wheel_module_exists, get_bdist_wheel_override - +_allowed_versions_cache = None -def check_allowed_python_version(): - """ - Make sure that setup.py is run with an allowed python version. - """ - import re +def get_allowed_python_versions(): + global _allowed_versions_cache + if _allowed_versions_cache is not None: + return _allowed_versions_cache pattern = r'Programming Language :: Python :: (\d+)\.(\d+)' supported = [] @@ -241,6 +125,17 @@ def check_allowed_python_version(): major = int(found.group(1)) minor = int(found.group(2)) supported.append((major, minor)) + + _allowed_versions_cache = sorted(supported) + return _allowed_versions_cache + + +def check_allowed_python_version(): + """ + Make sure that setup.py is run with an allowed python version. + """ + + supported = get_allowed_python_versions() this_py = sys.version_info[:2] if this_py not in supported: log.error(f"Unsupported python version detected. Supported versions: {supported}") @@ -250,76 +145,7 @@ def check_allowed_python_version(): qt_src_dir = '' -def is_debug_python(): - return getattr(sys, "gettotalrefcount", None) is not None - - -# Return a prefix suitable for the _install/_build directory -def prefix(): - virtual_env_name = os.environ.get('VIRTUAL_ENV', None) - if virtual_env_name is not None: - name = os.path.basename(virtual_env_name) - else: - name = "pyside" - name += str(sys.version_info[0]) - if OPTION["DEBUG"]: - name += "d" - if is_debug_python(): - name += "p" - if OPTION["LIMITED_API"] == "yes": - name += "a" - return name - - -# Initialize, pull and checkout submodules -def prepare_sub_modules(): - v = get_package_version() - print(f"Initializing submodules for {PYSIDE_MODULE} version: {v}") - submodules_dir = os.path.join(setup_script_dir, "sources") - - # Create list of [name, desired branch, absolute path, desired - # branch] and determine whether all submodules are present - need_init_sub_modules = False - - for m in submodules: - module_name = m[0] - module_dir = m[1] if len(m) > 1 else '' - module_dir = os.path.join(submodules_dir, module_dir, module_name) - # Check for non-empty directory (repository checked out) - if not os.listdir(module_dir): - need_init_sub_modules = True - break - - if need_init_sub_modules: - git_update_cmd = ["git", "submodule", "update", "--init"] - if run_process(git_update_cmd) != 0: - m = "Failed to initialize the git submodules: update --init failed" - raise DistutilsSetupError(m) - git_pull_cmd = ["git", "submodule", "foreach", "git", "fetch", "--all"] - if run_process(git_pull_cmd) != 0: - m = "Failed to initialize the git submodules: git fetch --all failed" - raise DistutilsSetupError(m) - else: - print("All submodules present.") - - git_update_cmd = ["git", "submodule", "update"] - if run_process(git_update_cmd) != 0: - m = "Failed to checkout the correct git submodules SHA1s." - raise DistutilsSetupError(m) - - def prepare_build(): - # Clean up temp build folder. - for n in ["build"]: - d = os.path.join(setup_script_dir, n) - if os.path.isdir(d): - log.info(f"Removing {d}") - try: - rmtree(d) - except Exception as e: - log.warn(f'***** problem removing "{d}"') - log.warn(f'ignored error: {e}') - # locate Qt sources for the documentation if OPTION["QT_SRC"] is None: install_prefix = QtInfo().prefix_dir @@ -329,38 +155,44 @@ def prepare_build(): if install_prefix.endswith("qtbase"): qt_src_dir = install_prefix else: # SDK: Use 'Src' directory - qt_src_dir = os.path.join(os.path.dirname(install_prefix), 'Src', 'qtbase') + maybe_qt_src_dir = Path(install_prefix).parent / 'Src' / 'qtbase' + if maybe_qt_src_dir.exists(): + qt_src_dir = maybe_qt_src_dir -class PysideInstall(_install, DistUtilsCommandMixin): +class PysideInstall(_install, CommandMixin): - user_options = _install.user_options + DistUtilsCommandMixin.mixin_user_options + user_options = _install.user_options + CommandMixin.mixin_user_options def __init__(self, *args, **kwargs): + self.command_name = "install" _install.__init__(self, *args, **kwargs) - DistUtilsCommandMixin.__init__(self) + CommandMixin.__init__(self) def initialize_options(self): _install.initialize_options(self) - if sys.platform == 'darwin': + def finalize_options(self): + CommandMixin.mixin_finalize_options(self) + _install.finalize_options(self) + + if sys.platform == 'darwin' or self.is_cross_compile: # Because we change the plat_name to include a correct - # deployment target on macOS distutils thinks we are + # deployment target on macOS setuptools thinks we are # cross-compiling, and throws an exception when trying to # execute setup.py install. The check looks like this # if self.warn_dir and build_plat != get_platform(): - # raise DistutilsPlatformError("Can't install when " - # "cross-compiling") + # raise PlatformError("Can't install when " + # "cross-compiling") # Obviously get_platform will return the old deployment # target. The fix is to disable the warn_dir flag, which # was created for bdist_* derived classes to override, for # similar cases. + # We also do it when cross-compiling. While calling install + # command directly is dubious, bdist_wheel calls install + # internally before creating a wheel. self.warn_dir = False - def finalize_options(self): - DistUtilsCommandMixin.mixin_finalize_options(self) - _install.finalize_options(self) - def run(self): _install.run(self) log.info(f"--- Install completed ({elapsed()}s)") @@ -398,11 +230,12 @@ class PysideBuildExt(_build_ext): class PysideBuildPy(_build_py): def __init__(self, *args, **kwargs): + self.command_name = "build_py" _build_py.__init__(self, *args, **kwargs) # _install_lib is reimplemented to preserve -# symlinks when distutils / setuptools copy files to various +# symlinks when setuptools copy files to various # directories from the setup tools build dir to the install dir. class PysideInstallLib(_install_lib): @@ -411,34 +244,45 @@ class PysideInstallLib(_install_lib): def install(self): """ - Installs files from build/xxx directory into final - site-packages/PySide6 directory. + Installs files from self.build_dir directory into final + site-packages/PySide6 directory when the command is 'install' + or into build/wheel when command is 'bdist_wheel'. """ - if os.path.isdir(self.build_dir): + if self.build_dir.is_dir(): # Using our own copydir makes sure to preserve symlinks. - outfiles = copydir(os.path.abspath(self.build_dir), os.path.abspath(self.install_dir)) + outfiles = copydir(Path(self.build_dir).resolve(), Path(self.install_dir).resolve()) else: self.warn(f"'{self.build_dir}' does not exist -- no Python modules to install") return return outfiles -class PysideBuild(_build, DistUtilsCommandMixin): +class PysideBuild(_build, CommandMixin, BuildInfoCollectorMixin): - user_options = _build.user_options + DistUtilsCommandMixin.mixin_user_options + user_options = _build.user_options + CommandMixin.mixin_user_options def __init__(self, *args, **kwargs): + self.command_name = "build" _build.__init__(self, *args, **kwargs) - DistUtilsCommandMixin.__init__(self) + CommandMixin.__init__(self) + BuildInfoCollectorMixin.__init__(self) def finalize_options(self): os_name_backup = os.name - DistUtilsCommandMixin.mixin_finalize_options(self) - if sys.platform == 'darwin': + CommandMixin.mixin_finalize_options(self) + BuildInfoCollectorMixin.collect_and_assign(self) + + use_os_name_hack = False + if self.is_cross_compile: + use_os_name_hack = True + elif sys.platform == 'darwin': self.plat_name = macos_plat_name() + use_os_name_hack = True + + if use_os_name_hack: # This is a hack to circumvent the dubious check in - # distutils.commands.build -> finalize_options, which only + # setuptool.commands.build -> finalize_options, which only # allows setting the plat_name for windows NT. # That is not the case for the wheel module though (which # does allow setting plat_name), so we circumvent by faking @@ -448,7 +292,10 @@ class PysideBuild(_build, DistUtilsCommandMixin): _build.finalize_options(self) - if sys.platform == 'darwin': + # Must come after _build.finalize_options + BuildInfoCollectorMixin.post_collect_and_assign(self) + + if use_os_name_hack: os.name = os_name_backup def initialize_options(self): @@ -467,110 +314,76 @@ class PysideBuild(_build, DistUtilsCommandMixin): self.build_type = "Release" self.qtinfo = None self.build_tests = False + self.python_target_info = {} def run(self): prepare_build() - platform_arch = platform.architecture()[0] - log.info(f"Python architecture is {platform_arch}") - self.py_arch = platform_arch[:-3] - - build_type = "Debug" if OPTION["DEBUG"] else "Release" - if OPTION["RELWITHDEBINFO"]: - build_type = 'RelWithDebInfo' # Check env make_path = None make_generator = None if not OPTION["ONLYPACKAGE"]: - (make_path, make_generator) = get_make(platform_arch, build_type) - - # Prepare parameters - py_executable = sys.executable - py_version = f"{sys.version_info[0]}.{sys.version_info[1]}" - py_include_dir = get_config_var("INCLUDEPY") - py_libdir = get_config_var("LIBDIR") - py_prefix = get_config_var("prefix") - if not py_prefix or not os.path.exists(py_prefix): - py_prefix = sys.prefix - self.py_prefix = py_prefix - if sys.platform == "win32": - py_scripts_dir = os.path.join(py_prefix, "Scripts") - else: - py_scripts_dir = os.path.join(py_prefix, "bin") - self.py_scripts_dir = py_scripts_dir + platform_arch = platform.architecture()[0] + (make_path, make_generator) = get_make(platform_arch, self.build_type) self.qtinfo = QtInfo() - qt_dir = os.path.dirname(OPTION["QTPATHS"]) - if OPTION['HAS_QMAKE_OPTION']: - qt_dir = os.path.dirname(OPTION["QMAKE"]) - qt_version = get_qt_version() - # Update the PATH environment variable - additional_paths = [self.py_scripts_dir, qt_dir] + # Don't add Qt to PATH env var, we don't want it to interfere + # with CMake's find_package calls which will use + # CMAKE_PREFIX_PATH. + # Don't add the Python scripts dir to PATH env when + # cross-compiling, it could be in the device sysroot (/usr) + # which can cause CMake device QtFooToolsConfig packages to be + # picked up instead of host QtFooToolsConfig packages. + additional_paths = [] + if self.py_scripts_dir and not self.is_cross_compile: + additional_paths.append(self.py_scripts_dir) # Add Clang to path for Windows. # Revisit once Clang is bundled with Qt. if (sys.platform == "win32" - and LooseVersion(self.qtinfo.version) >= LooseVersion("5.7.0")): - clang_dir = detect_clang() - if clang_dir[0]: - clangBinDir = os.path.join(clang_dir[0], 'bin') - if clangBinDir not in os.environ.get('PATH'): - log.info(f"Adding {clangBinDir} as detected by {clang_dir[1]} to PATH") + and parse_version(self.qtinfo.version) >= parse_version("5.7.0")): + clang_dir, clang_source = detect_clang() + if clang_dir: + clangBinDir = clang_dir / 'bin' + if str(clangBinDir) not in os.environ.get('PATH'): + log.info(f"Adding {clangBinDir} as detected by {clang_source} to PATH") additional_paths.append(clangBinDir) else: - raise DistutilsSetupError("Failed to detect Clang when checking " - "LLVM_INSTALL_DIR, CLANG_INSTALL_DIR, llvm-config") + raise SetupError("Failed to detect Clang when checking " + "LLVM_INSTALL_DIR, CLANG_INSTALL_DIR, llvm-config") update_env_path(additional_paths) - # Used for test blacklists and registry test. - self.build_classifiers = (f"py{py_version}-qt{qt_version}-{platform.architecture()[0]}-" - f"{build_type.lower()}") - - if OPTION["SHORTER_PATHS"]: - build_name = f"p{py_version}" - else: - build_name = self.build_classifiers - - script_dir = setup_script_dir - sources_dir = os.path.join(script_dir, "sources") - build_dir = os.path.join(script_dir, f"{prefix()}_build", f"{build_name}") - install_dir = os.path.join(script_dir, f"{prefix()}_install", f"{build_name}") - self.make_path = make_path self.make_generator = make_generator - self.script_dir = script_dir - self.st_build_dir = os.path.join(self.script_dir, self.build_lib) - self.sources_dir = sources_dir - self.build_dir = build_dir - self.install_dir = install_dir - self.py_executable = py_executable - self.py_include_dir = py_include_dir - self.py_library = get_py_library(build_type, py_version, py_prefix, - py_libdir, py_include_dir) - self.py_version = py_version - self.build_type = build_type - self.site_packages_dir = get_python_lib(1, 0, prefix=install_dir) + self.build_tests = OPTION["BUILDTESTS"] # Save the shiboken build dir path for clang deployment # purposes. - self.shiboken_build_dir = os.path.join(self.build_dir, SHIBOKEN) + self.shiboken_build_dir = self.build_dir / SHIBOKEN self.log_pre_build_info() # Prepare folders - if not os.path.exists(self.sources_dir): + if not self.sources_dir.exists(): log.info(f"Creating sources folder {self.sources_dir}...") os.makedirs(self.sources_dir) - if not os.path.exists(self.build_dir): + if not self.build_dir.exists(): log.info(f"Creating build folder {self.build_dir}...") os.makedirs(self.build_dir) - if not os.path.exists(self.install_dir): + if not self.install_dir.exists(): log.info(f"Creating install folder {self.install_dir}...") os.makedirs(self.install_dir) + # Write the CMake install path into a file. Is used by + # SetupRunner to provide a nicer UX when cross-compiling (no + # need to specify a host shiboken path explicitly) + if self.internal_cmake_install_dir_query_file_path: + with open(self.internal_cmake_install_dir_query_file_path, 'w') as f: + f.write(os.fspath(self.install_dir)) + if (not OPTION["ONLYPACKAGE"] and not config.is_internal_shiboken_generator_build_and_part_of_top_level_all()): # Build extensions @@ -581,12 +394,12 @@ class PysideBuild(_build, DistUtilsCommandMixin): # we record the latest successful build and note the # build directory for supporting the tests. timestamp = time.strftime('%Y-%m-%d_%H%M%S') - build_history = os.path.join(setup_script_dir, 'build_history') - unique_dir = os.path.join(build_history, timestamp) - os.makedirs(unique_dir) - fpath = os.path.join(unique_dir, 'build_dir.txt') + build_history = setup_script_dir / 'build_history' + unique_dir = build_history / timestamp + unique_dir.mkdir(parents=True) + fpath = unique_dir / 'build_dir.txt' with open(fpath, 'w') as f: - print(build_dir, file=f) + print(self.build_dir, file=f) print(self.build_classifiers, file=f) log.info(f"Created {build_history}") @@ -599,6 +412,42 @@ class PysideBuild(_build, DistUtilsCommandMixin): # Build packages _build.run(self) + + # Keep packaged directories for wheel construction + # This is to take advantage of the packaging step + # to keep the data in the proper structure to create + # a wheel. + _path = Path(self.st_build_dir) + _wheel_path = _path.parent / "package_for_wheels" + + _project = None + + if config.is_internal_shiboken_module_build(): + _project = "shiboken6" + elif config.is_internal_shiboken_generator_build(): + _project = "shiboken6_generator" + elif config.is_internal_pyside_build(): + _project = "PySide6" + + if _project is not None: + if not _wheel_path.exists(): + _wheel_path.mkdir(parents=True) + _src = Path(_path / _project) + _dst = Path(_wheel_path / _project) + # Remove the directory in case it exists. + # This applies to 'shiboken6', 'shiboken6_generator', + # and 'pyside6' inside the 'package_for_wheels' directory. + if _dst.exists(): + log.warning(f'Found directory "{_dst}", removing it first.') + remove_tree(_dst) + + try: + # This should be copied because the package directory + # is used when using the 'install' setup.py instruction. + copytree(_src, _dst) + except Exception as e: + log.warning(f'problem renaming "{self.st_build_dir}"') + log.warning(f'ignored error: {type(e).__name__}: {e}') else: log.info("Skipped preparing and building packages.") log.info(f"--- Build completed ({elapsed()}s)") @@ -607,7 +456,7 @@ class PysideBuild(_build, DistUtilsCommandMixin): if config.is_internal_shiboken_generator_build_and_part_of_top_level_all(): return - setuptools_install_prefix = get_python_lib(1) + setuptools_install_prefix = sysconfig.get_paths()["purelib"] if OPTION["FINAL_INSTALL_PREFIX"]: setuptools_install_prefix = OPTION["FINAL_INSTALL_PREFIX"] log.info("=" * 30) @@ -625,14 +474,14 @@ class PysideBuild(_build, DistUtilsCommandMixin): log.info(dedent(f""" Building {config.package_name()} will create and touch directories in the following order: - make build directory (py*_build/*/*) -> - make install directory (py*_install/*/*) -> - setuptools build directory (build/*/*) -> + make build directory -> + make install directory -> + setuptools build directory -> setuptools install directory (usually path-installed-python/lib/python*/site-packages/*) """)) - log.info(f"make build directory: {self.build_dir}") - log.info(f"make install directory: {self.install_dir}") + log.info(f"make build directory: {self.build_dir}") + log.info(f"make install directory: {self.install_dir}") log.info(f"setuptools build directory: {self.st_build_dir}") log.info(f"setuptools install directory: {setuptools_install_prefix}") log.info(dedent(f""" @@ -646,8 +495,12 @@ class PysideBuild(_build, DistUtilsCommandMixin): log.info(f"Python library: {self.py_library}") log.info(f"Python prefix: {self.py_prefix}") log.info(f"Python scripts: {self.py_scripts_dir}") + log.info(f"Python arch: {self.py_arch}") + log.info("-" * 3) + log.info(f"Qt prefix: {self.qtinfo.prefix_dir}") log.info(f"Qt qmake: {self.qtinfo.qmake_command}") + log.info(f"Qt qtpaths: {self.qtinfo.qtpaths_command}") log.info(f"Qt version: {self.qtinfo.version}") log.info(f"Qt bins: {self.qtinfo.bins_dir}") log.info(f"Qt docs: {self.qtinfo.docs_dir}") @@ -663,18 +516,26 @@ class PysideBuild(_build, DistUtilsCommandMixin): def build_patchelf(self): if not sys.platform.startswith('linux'): return - self._patchelf_path = find_executable('patchelf') + self._patchelf_path = which('patchelf') if self._patchelf_path: - if not os.path.isabs(self._patchelf_path): - self._patchelf_path = os.path.join(os.getcwd(), self._patchelf_path) + self._patchelf_path = Path(self._patchelf_path) + if not self._patchelf_path.is_absolute(): + self._patchelf_path = Path.cwd() / self._patchelf_path log.info(f"Using {self._patchelf_path} ...") return - log.info("Building patchelf...") - module_src_dir = os.path.join(self.sources_dir, "patchelf") - build_cmd = ["g++", f"{module_src_dir}/patchelf.cc", "-o", "patchelf"] - if run_process(build_cmd) != 0: - raise DistutilsSetupError("Error building patchelf") - self._patchelf_path = os.path.join(self.script_dir, "patchelf") + else: + raise SetupError("patchelf not found") + + def _enable_numpy(self): + if OPTION["ENABLE_NUMPY_SUPPORT"] or OPTION["PYSIDE_NUMPY_SUPPORT"]: + return True + if OPTION["DISABLE_NUMPY_SUPPORT"]: + return False + if self.is_cross_compile: # Do not search header in host Python + return False + # Debug builds require numpy to be built in debug mode on Windows + # https://numpy.org/devdocs/user/troubleshooting-importerror.html + return sys.platform != 'win32' or self.build_type.lower() != 'debug' def build_extension(self, extension): # calculate the subrepos folder name @@ -683,40 +544,48 @@ class PysideBuild(_build, DistUtilsCommandMixin): # Prepare folders os.chdir(self.build_dir) - module_build_dir = os.path.join(self.build_dir, extension) - skipflag_file = f"{module_build_dir} -skip" - if os.path.exists(skipflag_file): + module_build_dir = self.build_dir / extension + skipflag_file = Path(f"{module_build_dir}-skip") + if skipflag_file.exists(): log.info(f"Skipping {extension} because {skipflag_file} exists") return - module_build_exists = os.path.exists(module_build_dir) + module_build_exists = module_build_dir.exists() if module_build_exists: if not OPTION["REUSE_BUILD"]: log.info(f"Deleting module build folder {module_build_dir}...") try: - rmtree(module_build_dir) + remove_tree(module_build_dir) except Exception as e: log.error(f'***** problem removing "{module_build_dir}"') log.error(f'ignored error: {e}') else: log.info(f"Reusing module build folder {module_build_dir}...") - if not os.path.exists(module_build_dir): + if not module_build_dir.exists(): log.info(f"Creating module build folder {module_build_dir}...") os.makedirs(module_build_dir) os.chdir(module_build_dir) - module_src_dir = os.path.join(self.sources_dir, extension) + module_src_dir = self.sources_dir / extension # Build module - cmake_cmd = [OPTION["CMAKE"]] - if OPTION["QUIET"]: + cmake_cmd = [str(OPTION["CMAKE"])] + cmake_quiet_build = 1 + cmake_rule_messages = 0 + if OPTION["LOG_LEVEL"] == LogLevel.VERBOSE: # Pass a special custom option, to allow printing a lot less information when doing # a quiet build. - cmake_cmd.append('-DQUIET_BUILD=1') + cmake_quiet_build = 0 if self.make_generator == "Unix Makefiles": # Hide progress messages for each built source file. # Doesn't seem to work if set within the cmake files themselves. - cmake_cmd.append('-DCMAKE_RULE_MESSAGES=0') + cmake_rule_messages = 1 + + if OPTION["UNITY"]: + cmake_cmd.append("-DCMAKE_UNITY_BUILD=ON") + batch_size = OPTION["UNITY_BUILD_BATCH_SIZE"] + cmake_cmd.append(f"-DCMAKE_UNITY_BUILD_BATCH_SIZE={batch_size}") + log.info("Using UNITY build") cmake_cmd += [ "-G", self.make_generator, @@ -724,21 +593,38 @@ class PysideBuild(_build, DistUtilsCommandMixin): f"-DQt5Help_DIR={self.qtinfo.docs_dir}", f"-DCMAKE_BUILD_TYPE={self.build_type}", f"-DCMAKE_INSTALL_PREFIX={self.install_dir}", - module_src_dir + # Record the minimum/maximum Python version for later use in Shiboken.__init__ + f"-DMINIMUM_PYTHON_VERSION={get_allowed_python_versions()[0]}", + f"-DMAXIMUM_PYTHON_VERSION={get_allowed_python_versions()[-1]}", + f"-DQUIET_BUILD={cmake_quiet_build}", + f"-DCMAKE_RULE_MESSAGES={cmake_rule_messages}", + str(module_src_dir) ] - cmake_cmd.append(f"-DPYTHON_EXECUTABLE={self.py_executable}") - cmake_cmd.append(f"-DPYTHON_INCLUDE_DIR={self.py_include_dir}") - cmake_cmd.append(f"-DPYTHON_LIBRARY={self.py_library}") + + # When cross-compiling we set Python_ROOT_DIR to tell + # FindPython.cmake where to pick up the device python libs. + if self.is_cross_compile: + if self.python_target_path: + cmake_cmd.append(f"-DPython_ROOT_DIR={self.python_target_path}") + + # Host python is needed when cross compiling to run + # embedding_generator.py. Pass it as a separate option. + cmake_cmd.append(f"-DQFP_PYTHON_HOST_PATH={sys.executable}") + else: + cmake_cmd.append(f"-DPython_EXECUTABLE={self.py_executable}") + cmake_cmd.append(f"-DPython_INCLUDE_DIR={self.py_include_dir}") + cmake_cmd.append(f"-DPython_LIBRARY={self.py_library}") # If a custom shiboken cmake config directory path was provided, pass it to CMake. if OPTION["SHIBOKEN_CONFIG_DIR"] and config.is_internal_pyside_build(): config_dir = OPTION["SHIBOKEN_CONFIG_DIR"] - if os.path.exists(config_dir): + if config_dir.exists(): log.info(f"Using custom provided {SHIBOKEN} installation: {config_dir}") cmake_cmd.append(f"-DShiboken6_DIR={config_dir}") else: - log.info(f"Custom provided {SHIBOKEN} installation not found. Path given: {config_dir}") + log.info(f"Custom provided {SHIBOKEN} installation not found. " + f"Path given: {config_dir}") if OPTION["MODULE_SUBSET"]: module_sub_set = '' @@ -749,6 +635,7 @@ class PysideBuild(_build, DistUtilsCommandMixin): module_sub_set += ';' module_sub_set += m cmake_cmd.append(f"-DMODULES={module_sub_set}") + if OPTION["SKIP_MODULES"]: skip_modules = '' for m in OPTION["SKIP_MODULES"].split(','): @@ -760,35 +647,63 @@ class PysideBuild(_build, DistUtilsCommandMixin): cmake_cmd.append(f"-DSKIP_MODULES={skip_modules}") # Add source location for generating documentation cmake_src_dir = OPTION["QT_SRC"] if OPTION["QT_SRC"] else qt_src_dir - cmake_cmd.append(f"-DQT_SRC_DIR={cmake_src_dir}") + if cmake_src_dir: + cmake_cmd.append(f"-DQT_SRC_DIR={cmake_src_dir}") if OPTION['NO_QT_TOOLS']: cmake_cmd.append("-DNO_QT_TOOLS=yes") if OPTION['SKIP_DOCS']: - cmake_cmd.append("-DSKIP_DOCS=yes") + log.info("Warning: '--skip-docs' is deprecated and will be removed. " + "The documentation is not built by default") + if OPTION['BUILD_DOCS']: + cmake_cmd.append("-DBUILD_DOCS=yes") log.info(f"Qt Source dir: {cmake_src_dir}") + # Use Legacy OpenGL to avoid issues on systems like Ubuntu 20.04 + # which require to manually install the libraries which + # were previously linked to the QtGui module in 6.1 + # https://bugreports.qt.io/browse/QTBUG-89754 + cmake_cmd.append("-DOpenGL_GL_PREFERENCE=LEGACY") + if OPTION['AVOID_PROTECTED_HACK']: cmake_cmd.append("-DAVOID_PROTECTED_HACK=1") - numpy = get_numpy_location() - if numpy: - cmake_cmd.append(f"-DNUMPY_INCLUDE_DIR={numpy}") + if self._enable_numpy(): + numpy = get_numpy_location() + if numpy: + cmake_cmd.append(f"-DNUMPY_INCLUDE_DIR={numpy}") + else: + log.warning('numpy include directory was not found.') - if self.build_type.lower() == 'debug': - cmake_cmd.append(f"-DPYTHON_DEBUG_LIBRARY={self.py_library}") + if self.build_type.lower() != 'debug': + if OPTION['NO_STRIP']: + cmake_cmd.append("-DQFP_NO_STRIP=1") + if OPTION['NO_OVERRIDE_OPTIMIZATION_FLAGS']: + cmake_cmd.append("-DQFP_NO_OVERRIDE_OPTIMIZATION_FLAGS=1") if OPTION["LIMITED_API"] == "yes": cmake_cmd.append("-DFORCE_LIMITED_API=yes") elif OPTION["LIMITED_API"] == "no": cmake_cmd.append("-DFORCE_LIMITED_API=no") elif not OPTION["LIMITED_API"]: - pass + if sys.platform == 'win32' and self.debug: + cmake_cmd.append("-DFORCE_LIMITED_API=no") else: - raise DistutilsSetupError("option limited-api must be 'yes' or 'no' " - "(default yes if applicable, i.e. python version >= 3.6)") + raise SetupError("option limited-api must be 'yes' or 'no' " + "(default yes if applicable, i.e. Python " + "version >= 3.9 and release build if on Windows)") + + if OPTION["DISABLE_PYI"]: + cmake_cmd.append("-DDISABLE_PYI=yes") - if OPTION["VERBOSE_BUILD"]: + if OPTION["LOG_LEVEL"] == LogLevel.VERBOSE: cmake_cmd.append("-DCMAKE_VERBOSE_MAKEFILE:BOOL=ON") + else: + cmake_cmd.append("-DCMAKE_VERBOSE_MAKEFILE:BOOL=OFF") + + if OPTION['COMPILER_LAUNCHER']: + compiler_launcher = OPTION['COMPILER_LAUNCHER'] + cmake_cmd.append(f"-DCMAKE_C_COMPILER_LAUNCHER={compiler_launcher}") + cmake_cmd.append(f"-DCMAKE_CXX_COMPILER_LAUNCHER={compiler_launcher}") if OPTION["SANITIZE_ADDRESS"]: # Some simple sanity checking. Only use at your own risk. @@ -796,7 +711,7 @@ class PysideBuild(_build, DistUtilsCommandMixin): or sys.platform.startswith('darwin')): cmake_cmd.append("-DSANITIZE_ADDRESS=ON") else: - raise DistutilsSetupError("Address sanitizer can only be used on Linux and macOS.") + raise SetupError("Address sanitizer can only be used on Linux and macOS.") if extension.lower() == PYSIDE: pyside_qt_conf_prefix = '' @@ -809,6 +724,9 @@ class PysideBuild(_build, DistUtilsCommandMixin): pyside_qt_conf_prefix = '"."' cmake_cmd.append(f"-DPYSIDE_QT_CONF_PREFIX={pyside_qt_conf_prefix}") + if OPTION["STANDALONE"]: + cmake_cmd.append("-DSTANDALONE:BOOL=ON") + # Pass package version to CMake, so this string can be # embedded into _config.py file. package_version = get_package_version() @@ -823,8 +741,9 @@ class PysideBuild(_build, DistUtilsCommandMixin): cmake_cmd.append(f"-DPACKAGE_SETUP_PY_PACKAGE_TIMESTAMP={timestamp}") if extension.lower() in [SHIBOKEN]: - cmake_cmd.append("-DCMAKE_INSTALL_RPATH_USE_LINK_PATH=yes") - cmake_cmd.append("-DUSE_PYTHON_VERSION=3.6") + cmake_cmd.append("-DUSE_PYTHON_VERSION=3.9") + + cmake_cmd += platform_cmake_options() if sys.platform == 'darwin': if OPTION["MACOS_ARCH"]: @@ -853,7 +772,7 @@ class PysideBuild(_build, DistUtilsCommandMixin): # Set macOS minimum deployment target (version). # This is required so that calling - # run_process -> distutils.spawn() + # run_process -> subprocess.call() # does not set its own minimum deployment target # environment variable which is based on the python # interpreter sysconfig value. @@ -862,13 +781,9 @@ class PysideBuild(_build, DistUtilsCommandMixin): deployment_target = macos_pyside_min_deployment_target() cmake_cmd.append(f"-DCMAKE_OSX_DEPLOYMENT_TARGET={deployment_target}") os.environ['MACOSX_DEPLOYMENT_TARGET'] = deployment_target - elif sys.platform == 'win32': - # Prevent cmake from auto-detecting clang if it is in path. - cmake_cmd.append("-DCMAKE_C_COMPILER=cl.exe") - cmake_cmd.append("-DCMAKE_CXX_COMPILER=cl.exe") - if not OPTION["SKIP_DOCS"]: - # Build the whole documentation (rst + API) by default + if OPTION["BUILD_DOCS"]: + # Build the whole documentation (Base + API) by default cmake_cmd.append("-DFULLDOCSBUILD=1") if OPTION["DOC_BUILD_ONLINE"]: @@ -878,24 +793,54 @@ class PysideBuild(_build, DistUtilsCommandMixin): log.info("Output format will be qthelp") cmake_cmd.append("-DDOC_OUTPUT_FORMAT=qthelp") else: - cmake_cmd.append("-DSKIP_DOCS=1") + cmake_cmd.append("-DBUILD_DOCS=no") + if OPTION["DOC_BUILD_ONLINE"]: + log.info("Warning: Documentation build is disabled, " + "however --doc-build-online was passed. " + "Use '--build-docs' to enable the documentation build") if OPTION["PYSIDE_NUMPY_SUPPORT"]: - cmake_cmd.append("-DPYSIDE_NUMPY_SUPPORT=1") + log.info("Warning: '--pyside-numpy-support' is deprecated and will be removed. " + "Use --enable-numpy-support/--disable-numpy-support.") + + target_qt_prefix_path = self.qtinfo.prefix_dir + cmake_cmd.append(f"-DQFP_QT_TARGET_PATH={target_qt_prefix_path}") + if self.qt_host_path: + cmake_cmd.append(f"-DQFP_QT_HOST_PATH={self.qt_host_path}") + + if self.is_cross_compile and (not OPTION["SHIBOKEN_HOST_PATH"] + or not Path(OPTION["SHIBOKEN_HOST_PATH"]).exists()): + raise SetupError("Please specify the location of host shiboken tools via " + "--shiboken-host-path=") + + if self.shiboken_host_path: + cmake_cmd.append(f"-DQFP_SHIBOKEN_HOST_PATH={self.shiboken_host_path}") + + if self.shiboken_target_path: + cmake_cmd.append(f"-DQFP_SHIBOKEN_TARGET_PATH={self.shiboken_target_path}") + elif self.cmake_toolchain_file and not extension.lower() == SHIBOKEN: + # Need to tell where to find target shiboken when + # cross-compiling pyside. + cmake_cmd.append(f"-DQFP_SHIBOKEN_TARGET_PATH={self.install_dir}") + + if self.cmake_toolchain_file: + cmake_cmd.append(f"-DCMAKE_TOOLCHAIN_FILE={self.cmake_toolchain_file}") if not OPTION["SKIP_CMAKE"]: log.info(f"Configuring module {extension} ({module_src_dir})...") if run_process(cmake_cmd) != 0: - raise DistutilsSetupError(f"Error configuring {extension}") + raise SetupError(f"Error configuring {extension}") else: log.info(f"Reusing old configuration for module {extension} ({module_src_dir})...") log.info(f"-- Compiling module {extension}...") - cmd_make = [self.make_path] + cmd_make = [str(self.make_path)] if OPTION["JOBS"]: cmd_make.append(OPTION["JOBS"]) + if OPTION["LOG_LEVEL"] == LogLevel.VERBOSE and self.make_generator == "Ninja": + cmd_make.append("-v") if run_process(cmd_make) != 0: - raise DistutilsSetupError(f"Error compiling {extension}") + raise SetupError(f"Error compiling {extension}") if sys.version_info == (3, 6) and sys.platform == "darwin": # Python 3.6 has a Sphinx problem because of docutils 0.17 . @@ -904,21 +849,21 @@ class PysideBuild(_build, DistUtilsCommandMixin): if "UTF-8" not in os.environ.get("LC_ALL", ""): os.environ["LC_ALL"] = "en_US.UTF-8" - if not OPTION["SKIP_DOCS"]: + if OPTION["BUILD_DOCS"]: if extension.lower() == SHIBOKEN: - try: - # Check if sphinx is installed to proceed. - import sphinx - + found = importlib.util.find_spec("sphinx") + if found: log.info("Generating Shiboken documentation") - if run_process([self.make_path, "doc"]) != 0: - raise DistutilsSetupError("Error generating documentation " - f"for {extension}") - except ImportError: + make_doc_cmd = [str(self.make_path), "doc"] + if OPTION["LOG_LEVEL"] == LogLevel.VERBOSE and self.make_generator == "Ninja": + make_doc_cmd.append("-v") + if run_process(make_doc_cmd) != 0: + raise SetupError(f"Error generating documentation for {extension}") + else: log.info("Sphinx not found, skipping documentation build") else: - log.info("Skipped documentation generation") - cmake_cmd.append("-DSKIP_DOCS=1") + log.info("-- Skipped documentation generation. Enable with '--build-docs'") + cmake_cmd.append("-DBUILD_DOCS=no") if not OPTION["SKIP_MAKE_INSTALL"]: log.info(f"Installing module {extension}...") @@ -931,8 +876,8 @@ class PysideBuild(_build, DistUtilsCommandMixin): time.sleep(1) # ninja: error: unknown target 'install/fast' target = 'install/fast' if self.make_generator != 'Ninja' else 'install' - if run_process([self.make_path, target]) != 0: - raise DistutilsSetupError(f"Error pseudo installing {extension}") + if run_process([str(self.make_path), target]) != 0: + raise SetupError(f"Error pseudo installing {extension}") else: log.info(f"Skipped installing module {extension}") @@ -941,14 +886,14 @@ class PysideBuild(_build, DistUtilsCommandMixin): def prepare_packages(self): """ This will copy all relevant files from the various locations in the "cmake install dir", - to the setup tools build dir (which is read from self.build_lib provided by distutils). + to the setup tools build dir (which is read from self.build_lib provided by setuptools). After that setuptools.command.build_py is smart enough to copy everything from the build dir to the install dir (the virtualenv site-packages for example). """ try: - log.info("\nPreparing setup tools build directory.\n") - vars = { + log.info("Preparing setup tools build directory.") + _vars = { "site_packages_dir": self.site_packages_dir, "sources_dir": self.sources_dir, "install_dir": self.install_dir, @@ -961,42 +906,61 @@ class PysideBuild(_build, DistUtilsCommandMixin): "py_version": self.py_version, "qt_version": self.qtinfo.version, "qt_bin_dir": self.qtinfo.bins_dir, + "qt_data_dir": self.qtinfo.data_dir, "qt_doc_dir": self.qtinfo.docs_dir, "qt_lib_dir": self.qtinfo.libs_dir, + "qt_module_json_files_dir": self.qtinfo.module_json_files_dir, + "qt_metatypes_dir": self.qtinfo.metatypes_dir, "qt_lib_execs_dir": self.qtinfo.lib_execs_dir, "qt_plugins_dir": self.qtinfo.plugins_dir, "qt_prefix_dir": self.qtinfo.prefix_dir, "qt_translations_dir": self.qtinfo.translations_dir, "qt_qml_dir": self.qtinfo.qml_dir, + + # TODO: This is currently None when cross-compiling + # There doesn't seem to be any place where we can query + # it. Fortunately it's currently only used when + # packaging Windows vcredist. "target_arch": self.py_arch, } # Needed for correct file installation in generator build # case. if config.is_internal_shiboken_generator_build(): - vars['cmake_package_name'] = config.shiboken_module_option_name + _vars['cmake_package_name'] = config.shiboken_module_option_name os.chdir(self.script_dir) + # Clean up the previous st_build_dir before files are copied + # into it again. That's the because the same dir is used + # when copying the files for each of the sub-projects and + # we don't want to accidentally install shiboken files + # as part of pyside-tools package. + if self.st_build_dir.is_dir(): + log.info(f"Removing {self.st_build_dir}") + try: + remove_tree(self.st_build_dir) + except Exception as e: + log.warning(f'problem removing "{self.st_build_dir}"') + log.warning(f'ignored error: {e}') + if sys.platform == "win32": - vars['dbg_postfix'] = OPTION["DEBUG"] and "_d" or "" - return prepare_packages_win32(self, vars) + _vars['dbg_postfix'] = OPTION["DEBUG"] and "_d" or "" + return prepare_packages_win32(self, _vars) else: - return prepare_packages_posix(self, vars) + return prepare_packages_posix(self, _vars, self.is_cross_compile) except IOError as e: print('setup.py/prepare_packages: ', e) raise def qt_is_framework_build(self): - if os.path.isdir(self.qtinfo.headers_dir + "/../lib/QtCore.framework"): - return True - return False + return Path(f"{self.qtinfo.headers_dir}/../lib/QtCore.framework").is_dir() - def get_built_pyside_config(self, vars): + def get_built_pyside_config(self, _vars): # Get config that contains list of built modules, and # SOVERSIONs of the built libraries. - st_build_dir = vars['st_build_dir'] - config_path = os.path.join(st_build_dir, config.package_name(), "_config.py") + st_build_dir = Path(_vars['st_build_dir']) + config_path = st_build_dir / config.package_name() / "_config.py" temp_config = get_python_dict(config_path) if 'built_modules' not in temp_config: temp_config['built_modules'] = [] @@ -1014,11 +978,11 @@ class PysideBuild(_build, DistUtilsCommandMixin): """ log.info('Finding path to the libclang shared library.') cmake_cmd = [ - OPTION["CMAKE"], + str(OPTION["CMAKE"]), "-L", # Lists variables "-N", # Just inspects the cache (faster) "-B", # Specifies the build dir - self.shiboken_build_dir + str(self.shiboken_build_dir) ] out = run_process_output(cmake_cmd) lines = [s.strip() for s in out] @@ -1039,10 +1003,11 @@ class PysideBuild(_build, DistUtilsCommandMixin): # clang_lib_path points to the static import library # (lib/libclang.lib), whereas we want to copy the shared # library (bin/libclang.dll). - clang_lib_path = re.sub(r'lib/libclang.lib$', - 'bin/libclang.dll', - clang_lib_path) + clang_lib_path = Path(re.sub(r'lib/libclang.lib$', + 'bin/libclang.dll', + clang_lib_path)) else: + clang_lib_path = Path(clang_lib_path) # shiboken6 links against libclang.so.6 or a similarly # named library. # If the linked against library is a symlink, resolve @@ -1054,26 +1019,26 @@ class PysideBuild(_build, DistUtilsCommandMixin): # E.g. On Linux libclang.so -> libclang.so.6 -> # libclang.so.6.0. # "libclang.so.6" is the name we want for the copied file. - if os.path.islink(clang_lib_path): - link_target = os.readlink(clang_lib_path) - if os.path.isabs(link_target): + if clang_lib_path.is_symlink(): + link_target = Path(os.readlink(clang_lib_path)) + if link_target.is_absolute(): clang_lib_path = link_target else: # link_target is relative, transform to absolute. - clang_lib_path = os.path.join(os.path.dirname(clang_lib_path), link_target) - clang_lib_path = os.path.abspath(clang_lib_path) + clang_lib_path = clang_lib_path.parent / link_target + clang_lib_path = clang_lib_path.resolve() # The destination will be the shiboken package folder. - vars = {} - vars['st_build_dir'] = self.st_build_dir - vars['st_package_name'] = config.package_name() - destination_dir = "{st_build_dir}/{st_package_name}".format(**vars) + _vars = {} + _vars['st_build_dir'] = self.st_build_dir + _vars['st_package_name'] = config.package_name() + destination_dir = Path("{st_build_dir}/{st_package_name}".format(**_vars)) - if os.path.exists(clang_lib_path): - basename = os.path.basename(clang_lib_path) + if clang_lib_path.exists(): + basename = clang_lib_path.name log.info(f"Copying libclang shared library {clang_lib_path} to the package " f"folder as {basename}.") - destination_path = os.path.join(destination_dir, basename) + destination_path = destination_dir / basename # Need to modify permissions in case file is not writable # (a reinstall would cause a permission denied error). @@ -1085,19 +1050,50 @@ class PysideBuild(_build, DistUtilsCommandMixin): raise RuntimeError("Error copying libclang library " f"from {clang_lib_path} to {destination_dir}. ") + def get_shared_library_filters(self): + unix_filters = ["*.so", "*.so.*"] + darwin_filters = ["*.so", "*.dylib"] + filters = [] + if self.is_cross_compile: + if 'darwin' in self.plat_name or 'macos' in self.plat_name: + filters = darwin_filters + elif 'linux' in self.plat_name or 'android' in self.plat_name: + filters = unix_filters + else: + log.warning(f"No shared library filters found for platform {self.plat_name}. " + f"The package might miss Qt libraries and plugins.") + else: + if sys.platform == 'darwin': + filters = darwin_filters + else: + filters = unix_filters + return filters + + def _find_shared_libraries(self, path, recursive=False): + """Helper to find shared libraries in a path.""" + result = set() + for filter in self.get_shared_library_filters(): + glob_pattern = f"**/{filter}" if recursive else filter + for library in path.glob(glob_pattern): + result.add(library) + return list(result) + def package_libraries(self, package_path): """Returns the libraries of the Python module""" - UNIX_FILTERS = ["*.so", "*.so.*"] - DARWIN_FILTERS = ["*.so", "*.dylib"] - FILTERS = DARWIN_FILTERS if sys.platform == 'darwin' else UNIX_FILTERS - return [lib for lib in os.listdir( - package_path) if filter_match(lib, FILTERS)] + return self._find_shared_libraries(package_path) + + def get_shared_libraries_in_path_recursively(self, initial_path): + """Returns shared library plugins in given path (collected + recursively)""" + return self._find_shared_libraries(initial_path, recursive=True) - def update_rpath(self, package_path, executables, libexec=False): + def update_rpath(self, executables, libexec=False, message=None): ROOT = '@loader_path' if sys.platform == 'darwin' else '$ORIGIN' QT_PATH = '/../lib' if libexec else '/Qt/lib' + message = "Patched rpath to '$ORIGIN/' in" if sys.platform.startswith('linux'): + def rpath_cmd(srcpath): final_rpath = '' # Command line rpath option takes precedence over @@ -1115,6 +1111,8 @@ class PysideBuild(_build, DistUtilsCommandMixin): override=override) elif sys.platform == 'darwin': + message = "Updated rpath in" + def rpath_cmd(srcpath): final_rpath = '' # Command line rpath option takes precedence over @@ -1132,94 +1130,177 @@ class PysideBuild(_build, DistUtilsCommandMixin): raise RuntimeError(f"Not configured for platform {sys.platform}") # Update rpath - for srcname in executables: - srcpath = os.path.join(package_path, srcname) - if os.path.isdir(srcpath) or os.path.islink(srcpath): + for executable in executables: + if executable.is_dir() or executable.is_symlink(): + continue + if not executable.exists(): + continue + rpath_cmd(executable) + log.debug(f"{message} {executable}.") + + def update_rpath_for_linux_plugins( + self, + plugin_paths, + qt_lib_dir=None, + is_qml_plugin=False): + + # If the linux sysroot (where the plugins are copied from) + # is from a mainline distribution, it might have a different + # directory layout than then one we expect to have in the + # wheel. + # We have to ensure that any plugins copied have rpath + # values that can find Qt libs in the newly assembled wheel + # dir layout. + if not (self.is_cross_compile and sys.platform.startswith('linux') and self.standalone): + return + + log.info("Patching rpath for Qt and QML plugins.") + for plugin in plugin_paths: + if plugin.is_dir() or plugin.is_symlink(): continue - if not os.path.exists(srcpath): + if not plugin.exists(): continue - rpath_cmd(srcpath) - log.info("Patched rpath to '$ORIGIN/' (Linux) or " - f"updated rpath (OS/X) in {srcpath}.") + if is_qml_plugin: + plugin_dir = plugin.parent + # FIXME: there is no os.path.relpath equivalent on pathlib. + # The Path.relative_to is not equivalent and raises ValueError when the paths + # are not subpaths, so it doesn't generate "../../something". + rel_path_from_qml_plugin_qt_lib_dir = os.path.relpath(qt_lib_dir, plugin_dir) + rpath_value = Path("$ORIGIN") / rel_path_from_qml_plugin_qt_lib_dir + else: + rpath_value = "$ORIGIN/../../lib" -class PysideRstDocs(Command, DistUtilsCommandMixin): - description = "Build .rst documentation only" - user_options = DistUtilsCommandMixin.mixin_user_options + linux_fix_rpaths_for_library(self._patchelf_path, plugin, rpath_value, + override=True) + log.debug(f"Patched rpath to '{rpath_value}' in {plugin}.") + + def update_rpath_for_linux_qt_libraries(self, qt_lib_dir): + # Ensure that Qt libs and ICU libs have $ORIGIN in their rpath. + # Especially important for ICU lib, so that they don't + # accidentally load dependencies from the system. + if not (self.is_cross_compile and sys.platform.startswith('linux') and self.standalone): + return + + qt_lib_dir = Path(qt_lib_dir) + rpath_value = "$ORIGIN" + log.info(f"Patching rpath for Qt and ICU libraries in {qt_lib_dir}.") + for library in self.package_libraries(qt_lib_dir): + if library.is_dir() or library.is_symlink(): + continue + if not library.exists(): + continue + + linux_fix_rpaths_for_library(self._patchelf_path, library, rpath_value, override=True) + log.debug(f"Patched rpath to '{rpath_value}' in {library}.") + + +class PysideBaseDocs(Command, CommandMixin): + description = "Build the base documentation only" + user_options = CommandMixin.mixin_user_options + + def __init__(self, *args, **kwargs): + self.command_name = "build_base_docs" + Command.__init__(self, *args, **kwargs) + CommandMixin.__init__(self) def initialize_options(self): - DistUtilsCommandMixin.__init__(self) - log.info("-- This build process will not include the API documentation." + log.info("-- This build process will not include the API documentation. " "API documentation requires a full build of pyside/shiboken.") self.skip = False if config.is_internal_shiboken_generator_build(): self.skip = True if not self.skip: self.name = config.package_name().lower() - self.doc_dir = os.path.join(config.setup_script_dir, "sources") - self.doc_dir = os.path.join(self.doc_dir, self.name) - self.doc_dir = os.path.join(self.doc_dir, "doc") - try: - # Check if sphinx is installed to proceed. - import sphinx + self.doc_dir = config.setup_script_dir / "sources" / self.name / "doc" + # Check if sphinx is installed to proceed. + found = importlib.util.find_spec("sphinx") + self.html_dir = Path("html") + if found: if self.name == SHIBOKEN: + # Delete the 'html' directory since new docs will be generated anyway + if self.html_dir.is_dir(): + rmtree(self.html_dir) + log.info("-- Deleted old html directory") log.info("-- Generating Shiboken documentation") log.info(f"-- Documentation directory: 'html/{PYSIDE}/{SHIBOKEN}/'") elif self.name == PYSIDE: log.info("-- Generating PySide documentation") log.info(f"-- Documentation directory: 'html/{PYSIDE}/'") - except ImportError: - raise DistutilsSetupError("Sphinx not found - aborting") - self.html_dir = "html" + else: + raise SetupError("Sphinx not found - aborting") # creating directories html/pyside6/shiboken6 try: - if not os.path.isdir(self.html_dir): - os.mkdir(self.html_dir) + if not self.html_dir.is_dir(): + self.html_dir.mkdir(parents=True) if self.name == SHIBOKEN: - out_pyside = os.path.join(self.html_dir, PYSIDE) - if not os.path.isdir(out_pyside): - os.mkdir(out_pyside) - out_shiboken = os.path.join(out_pyside, SHIBOKEN) - if not os.path.isdir(out_shiboken): - os.mkdir(out_shiboken) + out_pyside = self.html_dir / PYSIDE + if not out_pyside.is_dir(): + out_pyside.mkdir(parents=True) + out_shiboken = out_pyside / SHIBOKEN + if not out_shiboken.is_dir(): + out_shiboken.mkdir(parents=True) self.out_dir = out_shiboken # We know that on the shiboken step, we already created the # 'pyside6' directory elif self.name == PYSIDE: - self.out_dir = os.path.join(self.html_dir, PYSIDE) + self.out_dir = self.html_dir / PYSIDE except (PermissionError, FileExistsError): - raise DistutilsSetupError(f"Error while creating directories for {self.doc_dir}") + raise SetupError(f"Error while creating directories for {self.doc_dir}") def run(self): if not self.skip: - cmake_cmd = [OPTION["CMAKE"]] - cmake_cmd += [ - "-S", self.doc_dir, - "-B", self.out_dir, + cmake_cmd = [ + str(OPTION["CMAKE"]), + "-S", str(self.doc_dir), + "-B", str(self.out_dir), "-DDOC_OUTPUT_FORMAT=html", "-DFULLDOCSBUILD=0", ] - if OPTION["QUIET"]: - cmake_cmd.append('-DQUIET_BUILD=1') + + cmake_quiet_build = 1 + cmake_message_log_level = "STATUS" + + # Define log level + if OPTION["LOG_LEVEL"] == LogLevel.VERBOSE: + cmake_quiet_build = 0 + cmake_message_log_level = "VERBOSE" + elif OPTION["LOG_LEVEL"] == LogLevel.QUIET: + cmake_message_log_level = "ERROR" + + cmake_cmd.append(f"-DQUIET_BUILD={cmake_quiet_build}") + cmake_cmd.append(f"-DCMAKE_MESSAGE_LOG_LEVEL={cmake_message_log_level}") + if run_process(cmake_cmd) != 0: - raise DistutilsSetupError(f"Error running CMake for {self.doc_dir}") + raise SetupError(f"Error running CMake for {self.doc_dir}") if self.name == PYSIDE: - self.sphinx_src = os.path.join(self.out_dir, "rst") + self.sphinx_src = self.out_dir / "base" + example_gallery = config.setup_script_dir / "tools" / "example_gallery" / "main.py" + assert example_gallery.is_file() + example_gallery_cmd = [sys.executable, os.fspath(example_gallery)] + if OPTION["LOG_LEVEL"] == LogLevel.QUIET: + example_gallery_cmd.append("--quiet") + qt_src_dir = OPTION['QT_SRC'] + if qt_src_dir: + example_gallery_cmd.extend(["--qt-src-dir", qt_src_dir]) + if run_process(example_gallery_cmd) != 0: + raise SetupError(f"Error running example gallery for {self.doc_dir}") elif self.name == SHIBOKEN: self.sphinx_src = self.out_dir - sphinx_cmd = ["sphinx-build", "-b", "html", "-c", self.sphinx_src, - self.doc_dir, self.out_dir] + sphinx_cmd = ["sphinx-build", "-b", "html", "-j", "auto", "-c", + str(self.sphinx_src), str(self.doc_dir), + str(self.out_dir)] if run_process(sphinx_cmd) != 0: - raise DistutilsSetupError(f"Error running CMake for {self.doc_dir}") + raise SetupError(f"Error running CMake for {self.doc_dir}") # Last message if not self.skip and self.name == PYSIDE: log.info(f"-- The documentation was built. Check html/{PYSIDE}/index.html") def finalize_options(self): - DistUtilsCommandMixin.mixin_finalize_options(self) + CommandMixin.mixin_finalize_options(self) cmd_class_dict = { @@ -1230,7 +1311,7 @@ cmd_class_dict = { 'develop': PysideDevelop, 'install': PysideInstall, 'install_lib': PysideInstallLib, - 'build_rst_docs': PysideRstDocs, + 'build_base_docs': PysideBaseDocs, } if wheel_module_exists: pyside_bdist_wheel = get_bdist_wheel_override() |