了解 Meson#

构建 SciPy 依赖于以下工具,这些工具可以被认为是构建系统的一部分

  • meson: Meson 构建系统,可作为纯 Python 包从 PyPI 或 conda-forge 安装

  • ninja: 由 Meson 调用以执行实际构建(例如,调用编译器)的构建工具。也可以从 PyPI(在所有常见平台上)或 conda-forge 安装。

  • pkg-config: 用于发现依赖项(特别是 BLAS/LAPACK)的工具。可在 conda-forge(以及 Homebrew、Chocolatey 和 Linux 包管理器)上找到,但未在 PyPI 上打包。

  • meson-python: Python 构建后端(即通过 pyproject.toml 中的钩子由构建前端(如 pippypa/build)调用的东西)。这是 Meson 之上的一个薄层,其主要作用是 (a) 与构建前端接口,以及 (b) 生成带有有效文件名和元数据的 sdists 和 wheels。

使用 Meson 构建分为几个阶段

  • 配置阶段 (meson setup) 用于检测编译器、依赖项和构建选项,并创建构建目录和 build.ninja 文件,

  • 编译阶段 (meson compileninja),其中编译构成构建的 SciPy 包一部分的扩展模块,

  • 安装阶段 (meson install) 用于将源目录和构建目录中的可安装文件安装到目标安装目录,

Meson 有一个良好的构建依赖项跟踪系统,因此第二次调用构建将仅重新构建任何源或依赖项已更改的目标。

了解更多关于 Meson 的信息#

Meson 有 非常好的文档;阅读它是有好处的,并且通常是“如何执行 X”的最佳答案来源。此外,可以在 https://nibblestew.blogspot.com/2021/12/this-year-receive-gift-of-free-meson.html 免费获得关于 Meson 的广泛 PDF 书籍

要了解更多关于 Meson 使用的设计原则,请查看 mesonbuild.com/Videos 中链接的最新演讲,它们也是一个很好的资源。

构建阶段的解释#

这仅用于教学目的;没有必要单独执行这些阶段。repo 根目录中的 dev.py 脚本也包含这些步骤,可以研究以获得见解。

假设我们从一个干净的 repo 和一个完全设置好的 conda 环境开始

git clone git@github.com:scipy/scipy.git
git submodule update --init
mamba env create -f environment.yml
mamba activate scipy-dev

现在运行构建的配置阶段,并指示 Meson 将构建工件放在 build/ 中,并在相对于 repo 根目录的 build-install/ 下进行本地安装,请执行

meson setup build --prefix=$PWD/build-install

然后运行构建的编译阶段,请执行

ninja -C build

在上面的命令中,-C 后面是构建目录的名称。您可以同时拥有多个构建目录。Meson 是完全异地的,因此这些构建不会相互干扰。例如,您可以在不同的目录中进行 GCC 构建、Clang 构建和调试构建。

然后将 SciPy 安装到前缀 (build-install/,但请注意这只是我们在此处选择的任意名称)

meson install -C build

它将安装到 build-install/lib/python3.11/site-packages/scipy,该路径不在您的 Python 路径上,因此要添加它,请执行 (同样,这仅用于学习目的,显式使用 ``PYTHONPATH`` 通常不是最好的主意)

export PYTHONPATH=$PWD/build-install/lib/python3.11/site-packages/

现在我们应该能够导入 scipy 并运行测试。记住我们需要移出 repo 的根目录,以确保我们选择的是包而不是本地的 scipy/ 源目录

cd doc
python -c "from scipy import constants as s; s.test()"

上面运行了单个模块 constants 的测试。其他运行测试的方法也应该有效,例如

pytest --pyargs scipy

完整的测试套件应该通过,在 Linux 上没有任何构建警告(至少在 CI 中强制执行 -Werror 的 GCC 版本),在其他平台上最多只有适量的警告。