# 3. 配置 Python

## 3.1. 构建要求

要构建 CPython，你需要：

- C11 编译器。 可选的 C11 特性 不是必须的。

- 在 Windows 上，需要 Microsoft Visual Studio 2017 或更新版本。

- 对 IEEE 754 浮点数和 浮点 Not-a-Number (NaN) 的支持。

- 对线程的支持。

在 3.5 版本发生变更: 在 Windows 上，现在需要 Visual Studio 2015 或更新的版本。

在 3.6 版本发生变更: 现在要求选定的 C99 特性，如 `<stdint.h>` 和 `static inline` 函数。

在 3.7 版本发生变更: 现在要求线程支持。

在 3.11 版本发生变更: C11 编译器，现在要求 IEEE 754 和 NaN 支持。 在 Windows 上，需要 Visual Studio 2017 或更新版本。

另请参阅 PEP 7 "Style Guide for C Code" 和 PEP 11 "CPython platform support"。

### 3.1.1. 针对可选模块的要求

标准库中的某些 可选模块 要求已安装某些第三方库用于开发（例如，某些头文件必须可用）。

缺失的要求将在 `configure` 输出中报告。 由于依赖缺失而缺失的模块将在 `make` 输出的结束位置列出，有时是使用内部名称，例如，与 `ctypes` 模块对应的 `_ctypes`。

如果你在不带可选模块的情况下分发 CPython 解释器，最好向用户提供建议，因为他们通常会预期标准库模块都是可用的。

构建可选模块的依赖如下：

依赖 | 最低版本 | Python 模块
--- | --- | ---
libbz2 |  | `bz2`
libffi | 建议 3.3.0 | `ctypes`
liblzma |  | `lzma`
libmpdec | 2.5.0 | `decimal` [1]
libreadline or libedit [2] |  | `readline`
libuuid |  | `_uuid` [3]
ncurses [4] |  | `curses`
OpenSSL | 建议 3.0.18 (最低 1.1.1) | `ssl`, `hashlib` [5]
SQLite | 3.15.2 | `sqlite3`
Tcl/Tk | 8.5.12 | `tkinter`, IDLE, `turtle`
zlib | 1.2.2.1 | `zlib`, `gzip`, `ensurepip`
zstd | 1.4.5 | `compression.zstd`

[1]

如果 libmpdec 不可用，则 `decimal` 模块将使用纯 Python 实现。 详情参见 `--with-system-libmpdec`。

[2]

请参阅 `--with-readline` 了解如何为 `readline` 模块选择后端。

[3]

`uuid` 模块使用 `_uuid` 来生成 "安全的" UUID。 详情参见模块文档。

[4]

`curses` 模块需要 `libncurses` 或 `libncursesw` 库。 `curses.panel` 模块还额外需要 `libpanel` 或 `libpanelw` 库。

[5]

如果 OpenSSL 不可用，则 `hashlib` 模块将使用几个哈希函数的捆绑实现。 请参阅 `--with-builtin-hashlib-hashes` 了解如何 强制 使用 OpenSSL。

请注意此表格并不包括所有可选模块；具体而言，平台专属的模块如 `winreg` 将不在这里列出。

参见

- devguide 包括了构建所有模块所需的完整依赖列表以及有关如何在常见平台上安装它们的指导。

- `--with-system-expat` 允许使用外部 libexpat 库进行构建。

- 用于第三方依赖的选项

在 3.1 版本发生变更: `tkinter` 现在需要 Tcl/Tk 8.3.1 版本。

在 3.5 版本发生变更: `tkinter` 现在需要 Tcl/Tk 8.4 版本。

在 3.7 版本发生变更: `hashlib` 和 `ssl` 现在需要 OpenSSL 1.0.2。

在 3.10 版本发生变更: `hashlib` 和 `ssl` 现在需要 OpenSSL 1.1.1。 `sqlite3` 现在需要 SQLite 3.7.15。

在 3.11 版本发生变更: `tkinter` 现在需要 Tcl/Tk 8.5.12 版本。

在 3.13 版本发生变更: `sqlite3` 现在需要 SQLite 3.15.2。

## 3.2. 已生成的文件

为了减少构建依赖性，Python 源代码包含多个已生成的文件。 重新生成所有已生成文件的命令如下:

    make regen-all
    make regen-stdlib-module-names
    make regen-limited-abi
    make regen-configure

`Makefile.pre.in` 文件记录了已生成的文件、它们的输入以及用于重新生成它们的工具。 搜索 `regen-*` make target。

### 3.2.1. 配置脚本

`make regen-configure` 命令将使用 `Tools/build/regen-configure.sh` shell 脚本生成 `aclocal.m4` 文件和 `configure` 脚本，它通过使用一个 Ubuntu 容器来获取同样的工具版本并具有可复现的输出。

容器是可选的，以下命令可以在本地运行:

    autoreconf -ivf -Werror

生成的文件可能由于所使用工具的实际版本而发生变化。 CPython 使用的容器中有 Autoconf 2.72, 来自 Automake 1.16.5 的 `aclocal`，以及 pkg-config 1.8.1。

在 3.13 版本发生变更: 现在会使用 autoconf 2.71 和 aclocal 1.16.5 来重新生成 `configure`。

在 3.14 版本发生变更: 现在会使用 autoconf 2.72 来生成 `configure`。

## 3.3. 配置选项

用以下方式列出所有 `configure` 脚本选项:

    ./configure --help

参阅 Python 源代码中的 `Misc/SpecialBuilds.txt` 。

### 3.3.1. 通用选项

--enable-loadable-sqlite-extensions

  在 `sqlite3` 模块的 `_sqlite` 扩展模块中是否支持可加载扩展（默认为否）。

  参见 `sqlite3.Connection.enable_load_extension()` 方法的 `sqlite3` 模块。

  Added in version 3.6.

--disable-ipv6

  禁用 IPv6 支持（若开启支持则默认启用），见 `socket` 模块。

--enable-big-digits=[15|30]

  定义 Python `int` 数字的比特大小：15或30比特

  在默认情况下，数位大小为 30。

  定义 `PYLONG_BITS_IN_DIGIT` 为 `15` 或 `30`。

  参见 `sys.int_info.bits_per_digit` 。

--with-suffix=SUFFIX

  将 Python 的可执行文件后缀设置为 SUFFIX。

  在 Windows 和 macOS 上默认后缀为 `.exe` (可执行文件为 `python.exe`)，在 Emscripten node 上为 `.js`，在 Emscripten 浏览器上为 `.html`，在 WASI 上为 `.wasm`，而在其他平台上为一个空字符串 (可执行文件为 `python`)。

  在 3.11 版本发生变更: 在 WASM 平台上默认后缀为 `.js`, `.html` 或 `.wasm` 之一。

--with-tzpath=<list of absolute paths separated by pathsep>

  Select the default time zone search path for为 `zoneinfo.TZPATH` 选择默认的时区搜索路径。 参见 `zoneinfo` 模块的 编译时配置。

  默认：`/usr/share/zoneinfo:/usr/lib/zoneinfo:/usr/share/lib/zoneinfo:/etc/zoneinfo`

  参阅 `os.pathsep` 路径分隔符。

  Added in version 3.9.

--without-decimal-contextvar

  编译 `_decimal` 扩展模块时使用线程本地上下文，而不是协程本地上下文（默认），参见 `decimal` 模块。

  参见 `decimal.HAVE_CONTEXTVAR` 和 `contextvars` 模块。

  Added in version 3.9.

--with-dbmliborder=<list of backend names>

  覆盖 `dbm` 模块的 db 后端检查顺序。

  合法值是用冒号（`:`）分隔的字符串，包含后端名称。

  - `ndbm` ；

  - `gdbm` ；

  - `bdb` 。

--without-c-locale-coercion

  禁用 C 语言对 UTF-8 的强制要求（默认为启用）。

  不定义 `PY_COERCE_C_LOCALE` 宏。

  参阅 `PYTHONCOERCECLOCALE` 和 PEP 538。

--with-platlibdir=DIRNAME

  Python 库目录名（默认为 `lib`）。

  Fedora 和 SuSE 在64 位平台用 `lib64` 。

  参阅 `sys.platlibdir` 。

  Added in version 3.9.

--with-wheel-pkg-dir=PATH

  `ensurepip` 模块用到的 wheel 包目录（默认为无）。

  某些 Linux 发行版的打包策略建议不要捆绑依赖关系。如 Fedora 在 `/usr/share/python-wheels/` 目录下安装 wheel 包，而不安装 `ensurepip._bundled` 包。

  Added in version 3.10.

--with-pkg-config=[check|yes|no]

  配置是否应当使用 pkg-config 来检测构建依赖。

  - `check` (默认值): pkg-config 为可选项

  - `yes`: pkg-config 为必选项。

  - `no`: 配置不使用 pkg-config 即使其存在

  Added in version 3.11.

--with-missing-stdlib-config=FILE

  Path to a JSON configuration file containing custom error messages for missing standard library modules.

  This option is intended for Python distributors who wish to provide distribution-specific guidance when users encounter standard library modules that are missing or packaged separately.

  The JSON file should map missing module names to custom error message strings. For example, if your distribution packages `tkinter` and `_tkinter` separately and excludes `_gdbm` for legal reasons, the configuration could contain:

      {
          "_gdbm": "The '_gdbm' module is not available in this distribution",
          "tkinter": "Install the python-tk package to use tkinter",
          "_tkinter": "Install the python-tk package to use tkinter",
      }

  Added in version 3.15.

--enable-pystats

  启用内部 Python 性能统计数据收集。

  在默认情况下，将关闭统计数据收集。 使用 `python3 -X pystats` 命令或设置 `PYTHONSTATS=1` 环境变量在 Python 启动时启用统计数据收集。

  在 Python 退出时，如果统计数据收集已启用且未清除则会转储统计数据。

  效果如下：

  - 增加了 `-X pystats` 命令行选项。

  - 增加了 `PYTHONSTATS` 环境变量。

  - 定义 `Py_STATS` 宏。

  - 为 `sys` 模块增加函数：

    - `sys._stats_on()`: 启用统计数据收集。

    - `sys._stats_off()`: 关闭统计数据收集。

    - `sys._stats_clear()`: 清除统计数据。

    - `sys._stats_dump()`: 将统计数据转储到文件，并清除统计数据。

  统计数据将被转储至 `/tmp/py_stats/` (Unix) 或 `C:\temp\py_stats\` (Windows) 中的任意（可能唯一）文件。 如果该目录不存在，结果将被打印到 stderr。

  使用 `Tools/scripts/summarize_stats.py` 来读取统计数据。

  统计数据：

  - 操作码：

    - 专门类别: success, failure, hit, deferred, miss, deopt, failures；

    - 执行计数；

    - 对应计数。

  - 调用：

    - 内联 Python 调用；

    - PyEval 调用；

    - 推入的帧；

    - 创建的帧对象；

    - Eval 调用: vector, generator, legacy, function VECTORCALL, build class, slot, function "ex", API, method。

  - 对象：

    - incref 和 decref；

    - 解释器 incref 和 decref；

    - 分配: all, 512 bytes, 4 kiB, big；

    - 空闲；

    - 去向/来自空闲列表；

    - 实体化/非实体化的字典；

    - 类型缓存；

    - 优化尝试；

    - 已创建/已执行的优化跟踪；

    - 已执行的 uop。

  - 垃圾回收器：

    - 垃圾回收；

    - 已访问的对象；

    - 已收集的对象。

  Added in version 3.11.

--disable-gil

  启用对在不带 global interpreter lock (GIL) 的情况下运行 Python 的支持: free-threaded build。

  定义 `Py_GIL_DISABLED` 宏并向 `sys.abiflags` 添加 `"t"`。

  请参阅 自由线程的 CPython 了解详情。

  Added in version 3.13.

--enable-experimental-jit=[no|yes|yes-off|interpreter]

  指明如何集成 实验性的即时编译器。

  - `no`：不构建JIT。

  - `yes`: 启用 JIT。 要在运行时禁用 JIT，设置环境变量 `PYTHON_JIT=0`。

  - `yes-off`: 构建 JIT ，但默认禁用它。 要在运行时启用 JIT，则设置环境变量 `PYTHON_JIT=1`。

  - `interpreter`：启用“JIT解释器”（只对调试JIT本身有用）。要在运行时禁用，则设置环境变量 `PYTHON_JIT=0`。

  如果该选项未提供，`--enable-experimental-jit=no``是默认行为，`--enable-experimental-jit``是``--enable-experimental-jit=yes``的缩写。更多信息请参见:file:Tools/jit/README.md，包括如何安装必要的构建时依赖项。

  备注

  当构建启用的 JIT 的 CPython 时，请确保你的系统已安装了 Python 3.11 或更新的版本。

  Added in version 3.13.

PKG_CONFIG

  指向 `pkg-config` 工具的路径。

PKG_CONFIG_LIBDIR

PKG_CONFIG_PATH

  `pkg-config` 选项。

### 3.3.2. C 编译器选项

CC

  C 编译器指令。

CFLAGS

  C 编译器标志。

CPP

  C 预处理器命令。

CPPFLAGS

  C 预处理器旗标，例如 `-Iinclude_dir`。

### 3.3.3. 链接器选项

LDFLAGS

  链接器旗标，例如 `-Llibrary_directory`。

LIBS

  要传给链接器的库，例如 `-llibrary`。

MACHDEP

  依赖具体机器的库文件名称。

### 3.3.4. 用于第三方依赖的选项

Added in version 3.11.

BZIP2_CFLAGS

BZIP2_LIBS

  将 Python 链接到 `libbz2` 的 C 编译器和链接器旗标，由 `bz2` 模块使用，覆盖 `pkg-config`。

CURSES_CFLAGS

CURSES_LIBS

  针对 `libncurses` 或 `libncursesw` 的 C 编译器和链接器旗标，由 `curses` 模块使用，覆盖 `pkg-config`。

GDBM_CFLAGS

GDBM_LIBS

  针对 `gdbm` 的 C 编译器和链接器旗标。

LIBEDIT_CFLAGS

LIBEDIT_LIBS

  针对 `libedit` 的 C 编译器和链接器旗标，由 `readline` 模块使用，覆盖 `pkg-config`。

LIBFFI_CFLAGS

LIBFFI_LIBS

  针对 `libffi` 的 C 编译器和链接器旗标，由 `ctypes` 模块使用，覆盖 `pkg-config`。

LIBMPDEC_CFLAGS

LIBMPDEC_LIBS

  针对 `libmpdec` 的 C 编译器和链接器旗标，由 `decimal` 模块使用，覆盖 `pkg-config`。

  备注

  除非指定了 `--with-system-libmpdec` 否则这些环境变量将没有效果。

LIBLZMA_CFLAGS

LIBLZMA_LIBS

  针对 `liblzma` 的 C 编译器和链接器旗标，由 `lzma` 模块使用，覆盖 `pkg-config`。

LIBREADLINE_CFLAGS

LIBREADLINE_LIBS

  针对 `libreadline` 的 C 编译器和链接器旗标，由 `readline` 模块使用，覆盖 `pkg-config`。

LIBSQLITE3_CFLAGS

LIBSQLITE3_LIBS

  针对 `libsqlite3` 的 C 编译器和链接器旗标，由 `sqlite3` 模块使用，覆盖 `pkg-config`。

LIBUUID_CFLAGS

LIBUUID_LIBS

  针对 `libuuid` 的 C 编译器和链接器旗标，由 `uuid` 模块使用，覆盖 `pkg-config`。

LIBZSTD_CFLAGS

LIBZSTD_LIBS

  针对 `libzstd` 的 C 编译器和链接器旗标，由 `compression.zstd` 模块使用，覆盖 `pkg-config`。

  Added in version 3.14.

PANEL_CFLAGS

PANEL_LIBS

  针对 PANEL 的 C 编译器和链接器旗标，覆盖 `pkg-config`。

  针对 `libpanel` 或 `libpanelw` 的 C 编译器和链接器旗标，由 `curses.panel` 模块使用，覆盖 `pkg-config`。

TCLTK_CFLAGS

TCLTK_LIBS

  针对 TCLTK 的 C 编译器和链接器旗标，覆盖 `pkg-config`。

ZLIB_CFLAGS

ZLIB_LIBS

  针对 `libzlib` 的 C 编译器和链接器旗标，由 `gzip` 模块使用，覆盖 `pkg-config`。

### 3.3.5. WebAssembly 选项。

--enable-wasm-dynamic-linking

  为 WASM 启用动态链接支持。

  动态链接启用 `dlopen`。 可执行文件的大小将由于限制死代码清理和附加特性而增加。

  Added in version 3.11.

--enable-wasm-pthreads

  为 WASM 启用 pthreads 支持。

  Added in version 3.11.

### 3.3.6. 安装时的选项

--prefix=PREFIX

  在 PREFIX 中安装架构无关的文件。 在 Unix 上，它默认为 `/usr/local`。

  该值可在运行时使用 `sys.prefix` 获取。

  作为示例，用户可以使用 `--prefix="$HOME/.local/"` 在其家目录中安装 Python。

--exec-prefix=EPREFIX

  在 EPREFIX 中安装架构无关的文件，默认为 `--prefix`。

  该值可在运行时使用 `sys.exec_prefix` 获取。

--disable-test-modules

  不编译和安装 test 模块，如 `test` 包或 `_testcapi` 扩展模块（默认会编译并安装）。

  Added in version 3.10.

--with-ensurepip=[upgrade|install|no]

  选择 Python 安装时运行的 `ensurepip` 命令。

  - `upgrade` （默认）：运行 `python -m ensurepip --altinstall --upgrade` 命令。

  - `install` ：运行 `python -m ensurepip --altinstall` 命令。

  - `no` ：不运行 ensurepip。

  Added in version 3.6.

### 3.3.7. 性能选项

为获得最佳性能推荐使用 `--enable-optimizations --with-lto` (PGO + LTO) 来配置 Python。 试验性的 `--enable-bolt` 旗标也可被用来提升性能。

--enable-optimizations

  用 `PROFILE_TASK` 启用以配置文件主导的优化（PGO）（默认为禁用）。

  C 编译器 Clang 需要用到 `llvm-profdata` 程序进行 PGO。在 macOS 上，GCC 也需要用到它：在 macOS 上 GCC 只是 Clang 的别名而已。

  如果使用 `--enable-shared` 和 GCC ，还可以禁用 libpython 中的语义插值：在编译器和链接器的标志中加入 `-fno-semantic-interposition` 。

  备注

  在构建期间，你可能会遇到编译器警告提示某些源文件的配置数据不可用。 这些警告是无害的，因为在获取配置数据时只有一部分代码会被使用。 要在 Clang 上禁用这些警告，可通过在 `CFLAGS` 中添加 `-Wno-profile-instr-unprofiled` 来手动抑制它们。

  Added in version 3.6.

  在 3.10 版本发生变更: 在 GCC 上使用 `-fno-semantic-interposition` 。

PROFILE_TASK

  Makefile 用到的环境变量：PGO 用到的 Python 命令行参数。

  默认为：`-m test --pgo --timeout=$(TESTTIMEOUT)` 。

  Added in version 3.8.

  在 3.13 版本发生变更: 任务失败将不会再被静默地忽略。

--with-lto=[full|thin|no|yes]

  在编译过程中启用链接时间优化（LTO）（默认为禁用）。

  LTO 时 C 编译器 Clang 需要用到 `llvm-ar` 参数（在 macOS 则为 `ar`），以及支持 LTO 的链接器（`ld.gold` 或 `lld`）。

  Added in version 3.6.

  Added in version 3.11: 要使用 ThinLTO 特性，请在 Clang 上使用 `--with-lto=thin`。

  在 3.12 版本发生变更: 如果编译器支持将使用 ThinLTO 旗标作为 Clang 上的默认优化策略。

--enable-bolt

  允许启用 BOLT 链接后二进制优化器 (默认为禁用)。

  BOLT 是 LLVM 项目的一部分但并不总是包括在其二进制分发包中。 该旗标要求 `llvm-bolt` 和 `merge-fdata` 可用。

  BOLT 仍然是一个相当新的项目因此目前该旗标应当被视为是试验性的。 因为此工具是作用于机器码所以其成功依赖于构建环境 + 其他优化配置参数 + CPU 架构的组合，并且并非所有组合都受到支持。 已知 LLVM 16 之前的 BOLT 版本在某些场景下会使得 BOLT 发生崩溃。 强烈建议使用 LLVM 16 或更新版本进行 BOLT 优化。

  `BOLT_INSTRUMENT_FLAGS` 和 `BOLT_APPLY_FLAGS` configure 变量可被定义为覆盖 llvm-bolt 的默认参数集合来分别指示和将 BOLT 数据应用于二进制代码中。

  Added in version 3.12.

BOLT_APPLY_FLAGS

  当创建 BOLT 优化的二进制文件 时传给 `llvm-bolt` 的参数。

  Added in version 3.12.

BOLT_INSTRUMENT_FLAGS

  当构建二进制文件时传给 `llvm-bolt` 的参数。

  Added in version 3.12.

--with-computed-gotos

  在求值环节启用 goto 计数（在支持的编译器上默认启用）。

--with-tail-call-interp

  在CPython中启用使用尾部调用的解释器。如果启用，强烈建议启用PGO（`--enable-optimizations`）。这个选项特别需要具有适当尾部调用支持的C编译器，以及 preserve_none 调用约定。例如，Clang 19及更新版本支持此特性。

  Added in version 3.14.

--without-mimalloc

  禁用快速的 mimalloc 分配器（默认为启用）。

  参见环境变量 `PYTHONMALLOC` 。

--without-pymalloc

  禁用特定的 Python 内存分配器 pymalloc （默认为启用）。

  参见环境变量 `PYTHONMALLOC` 。

--with-pymalloc-hugepages

  Enable huge page support for pymalloc arenas (disabled by default). When enabled, the arena size on 64-bit platforms is increased to 2 MiB and arena allocation uses `MAP_HUGETLB` (Linux) or `MEM_LARGE_PAGES` (Windows) with automatic fallback to regular pages.

  Even when compiled with this option, huge pages are not used at runtime unless the `PYTHON_PYMALLOC_HUGEPAGES` environment variable is set to `1`. This opt-in is required because huge pages carry risks on Linux: if the huge-page pool is exhausted, page faults (including copy-on-write faults after `os.fork()`) deliver `SIGBUS` and kill the process.

  The configure script checks that the platform supports `MAP_HUGETLB` and emits a warning if it is not available.

  On Windows, use the `--pymalloc-hugepages` flag with `build.bat` or set the `UsePymallocHugepages` MSBuild property.

  Added in version 3.15.

--without-doc-strings

  禁用静态文档字符串以减少内存占用（默认启用）。Python 中定义的文档字符串不受影响。

  不定义 `PY_COERCE_C_LOCALE` 宏。

  参阅宏 `PyDoc_STRVAR()` 。

--enable-profiling

  用 `gprof` 启用 C 语言级的代码评估（默认为禁用）。

--with-strict-overflow

  将 `-fstrict-overflow` 添加到 C 编译器旗标 (在默认情况下我们将添加 `-fno-strict-overflow` 来代替)。

--without-remote-debug

  停用 PEP 768 中描述的远程调试支持（默认启用）。 当提供此标志时，不会编译允许解释器按照 PEP 768 中所述在单独进程中调度 Python 文件执行的代码。 这包括调度要执行的代码的功能和接收要执行的代码的功能。

  Py_REMOTE_DEBUG

    这个宏默认将被定义，除非 Python 配置了 `--without-remote-debug`。

    请注意即使定义了这个宏，远程调试可能仍然不可用（例如，在不兼容的平台上）。

  Added in version 3.14.

### 3.3.8. Python 调试级编译

调试版本 Python 是指带有 `--with-pydebug` 参数的编译。

调试版本的效果：

- 默认显示所有警告：在 `warnings` 模块中，默认警告过滤器的列表是空的。

- 在 `sys.abiflags` 中加入 `d` 标记。

- 加入 `sys.gettotalrefcount()` 函数。

- 命令行参数加入 `-X showrefcount` 。

- 添加 `-d` 命令行选项和 `PYTHONDEBUG` 环境变量用于调试解析器。

- 添加对 `__lltrace__` 变量的支持：如果定义了该变量则会在字节码求值循环中启用低层级追踪。

- 安装 内存分配调试钩子 ，以便检测缓冲区溢出和其他内存错误。

- 定义宏 `Py_DEBUG` 和 `Py_REF_DEBUG` 。

- 增加运行时检查：针对由 `#ifdef Py_DEBUG` 和 `#endif` 所包裹的代码。 启用 `assert(...)` 和 `_PyObject_ASSERT(...)` 断言：不设置 `NDEBUG` 宏（另请参阅 `--with-assertions` 配置选项）。 主要的运行时检查有:

  - 增加了对函数参数的合理性检查。

  - 创建 Unicode 和 int 对象时，内存按某种模式进行了填充，用于检测是否使用了未初始化的对象。

  - 确保有能力清除或替换当前异常的函数在调用时不会引发异常。

  - 检查内存释放器函数是否不改变当前异常。

  - 垃圾收集器（`gc.collect()` 函数）对对象的一致性进行一些基本检查。

  - 从较宽类型转换到较窄类型时，`Py_SAFE_DOWNCAST()` 宏会检查整数下溢和上溢的情况。

参见 Python 开发模式 和配置参数 `--with-trace-refs` 。

在 3.8 版本发生变更: 发布构建版和调试构建版现在是 ABI 兼容的：定义了 `Py_DEBUG` 宏不再意味着同时定义了 `Py_TRACE_REFS` 宏（参见 `--with-trace-refs` 选项）。

### 3.3.9. 调试选项

--with-pydebug

  在调试模式下编译 Python: 定义宏 `Py_DEBUG` (默认为禁用)。

--with-trace-refs

  为了调试而启用引用的跟踪（默认为禁用）。

  效果如下：

  - 定义 `Py_TRACE_REFS` 宏。

  - 加入 `sys.getobjects()` 函数。

  - 环境变量加入 `PYTHONDUMPREFS` 。

  `PYTHONDUMPREFS` 环境变量可被用来转储在 Python 退出时仍然存活的对象和引用计数。

  静态分配的对象 将不会被追踪。

  Added in version 3.8.

  在 3.13 版本发生变更: 此构建版现在与发布构建版和 调试构建版 是 ABI 兼容的。

--with-assertions

  编译时启用 C 断言：`assert(...);` 和 `_PyObject_ASSERT(...);` （默认不启用）。

  如果设置此参数，则在 `OPT` 编译器变量中不定义 `NDEBUG` 宏。

  参阅 `--with-pydebug` 选项（调试编译模式），它也可以启用断言。

  Added in version 3.6.

--with-valgrind

  启用 Valgrind （默认禁用）。

--with-dtrace

  启用 DTrace（默认禁用）。

  参阅 用 DTrace 和 SystemTap 测试 CPython。

  Added in version 3.6.

--with-address-sanitizer

  启用 AddressSanitizer 内存错误检测器（简称 `asan`，默认不启用）。若要增强 ASan 的检测能力，你还可以结合使用 `--without-pymalloc` 选项来禁用专门用于小对象分配的内存分配器——该分配器的分配行为不会被 ASan 追踪。

  Added in version 3.6.

--with-memory-sanitizer

  启用 MemorySanitizer 内存错误检测 `msan`，（默认为禁用）。

  Added in version 3.6.

--with-undefined-behavior-sanitizer

  启用 undefinedBehaviorSanitizer 未定义行为检测 `ubsan`，（默认为禁用）。

  Added in version 3.6.

--with-thread-sanitizer

  启用 ThreadSanitizer 数据竞争检测器，`tsan` (默认为否）。

  Added in version 3.13.

### 3.3.10. 链接器选项

--enable-shared

  启用共享 Python 库 `libpython` 的编译（默认为禁用）。

--without-static-libpython

  不编译 `libpythonMAJOR.MINOR.a`，也不安装 `python.o` (默认会编译并安装)。

  Added in version 3.10.

### 3.3.11. 库选项

--with-libs='lib1 ...'

  链接附加库（默认不会）。

--with-system-expat

  用已安装的 `expat` 库编译 `pyexpat` 模块（默认为否）。

--with-system-libmpdec

  使用已安装的 `mpdecimal` 库来构建 `_decimal` 扩展模块，参见 `decimal` 模块（默认为是）。

  Added in version 3.3.

  在 3.13 版本发生变更: 默认为使用已安装的 `mpdecimal` 库。

  在 3.15 版本发生变更: 如果未找到已安装的 `mpdecimal` 库则不会再隐式地选择该库的捆绑副本。 只有在 Python 3.15 中，仍可使用 `--with-system-libmpdec=no` 或 `--without-system-libmpdec` 显式地选择它。

  从 3.13 版起已弃用，将在 3.16 版中移除: `mpdecimal` 库源代码的副本将不再随 Python 3.16 一起分发。

  参见

  `LIBMPDEC_CFLAGS` 和 `LIBMPDEC_LIBS`。

--with-readline=readline|editline

  为 `readline` 模块指定一个后端库。

  - readline: 使用 readline 作为后端。

  - editline: 使用 editline 作为后端。

  Added in version 3.10.

--without-readline

  不编译 `readline` 模块（默认会）。

  不定义 `HAVE_LIBREADLINE` 宏。

  Added in version 3.10.

--with-libm=STRING

  将 `libm` 数学库覆盖为 STRING (默认情况视系统而定)。

--with-libc=STRING

  将 `libc` C 库覆盖为 STRING (默认情况视系统而定)。

--with-openssl=DIR

  OpenSSL 的根目录。

  Added in version 3.7.

--with-openssl-rpath=[no|auto|DIR]

  设置 OpenSSL 库的运行时库目录（rpath）。

  - `no` (默认): 不设置 rpath。

  - `auto`：根据 `--with-openssl` 和 `pkg-config` 自动检测 rpath。

  - DIR ：直接设置 rpath。

  Added in version 3.10.

### 3.3.12. 安全性选项

--with-hash-algorithm=[fnv|siphash13|siphash24]

  选择 `Python/pyhash.c` 采用的哈希算法。

  - `siphash13` (默认值);

  - `siphash24`;

  - `fnv`.

  Added in version 3.4.

  Added in version 3.11: 增加了 `siphash13` 并且是新的默认值。

--with-builtin-hashlib-hashes=md5,sha1,sha256,sha512,sha3,blake2

  内置哈希模块：

  - `md5`。

  - `sha1`。

  - `sha256`。

  - `sha512`。

  - `sha3` (带 shake)。

  - `blake2`。

  Added in version 3.9.

--with-ssl-default-suites=[python|openssl|STRING]

  覆盖 OpenSSL 默认的密码套件字符串。

  - `python` (默认值): 采用 Python 推荐选择。

  - `openssl`：保留 OpenSSL 默认值不动。

  - STRING ：采用自定义字符串。

  参见 `ssl` 模块。

  Added in version 3.7.

  在 3.10 版本发生变更: 设置 `python` 和 STRING 也会把 TLS 1.2 设为最低版本的协议。

--disable-safety

  出于安全原因，禁用 OpenSSF推荐 的编译器选项，而不会产生性能开销。如果未启用此选项，CPython将基于安全编译器选项构建，不会减慢速度。启用此选项后，将不会使用下面列出的编译器选项构建CPython。

  使用 `--disable-safety` 禁用以下编译器选项：

  - -fstack-protector-strong：启用基于堆栈的缓冲区溢出的运行时检查。

  - -Wtrampolines：启用关于需要可执行堆栈的蹦床的警告。

  Added in version 3.14.

--enable-slower-safety

  出于安全原因，启用 OpenSSF推荐 的编译器选项，需要开销。如果未启用此选项，则CPython将不会基于影响性能的安全编译器选项进行构建。启用此选项后，CPython将使用下面列出的编译器选项进行构建。

  使用 `--enable-slower-safety` 来启用以下编译器选项：

  - -D_FORTIFY_SOURCE=3：通过编译和运行时检查来加强源代码，以防止不安全的libc用法和缓冲区溢出。

  Added in version 3.14.

### 3.3.13. macOS 选项

参见 Mac/README.rst。

--enable-universalsdk

--enable-universalsdk=SDKDIR

  创建通用的二进制版本。SDKDIR 指定应采用的 macOS SDK （默认为否）。

--enable-framework

--enable-framework=INSTALLDIR

  创建 Python.framework ，而不是传统的 Unix 安装版。可选参数 INSTALLDIR 指定了安装路径（(默认为否）。

--with-universal-archs=ARCH

  指定应创建何种通用二进制文件。该选项仅当设置了 `--enable-universalsdk` 时才有效。

  可选项：

  - `universal2` (x86-64 和 arm64);

  - `32-bit` (PPC 和 i386);

  - `64-bit` (PPC64 和 x86-64);

  - `3-way` (i386, PPC 和 x86-64);

  - `intel` (i386 和 x86-64);

  - `intel-32` (i386);

  - `intel-64` (x86-64);

  - `all` (PPC, i386, PPC64 和 x86-64).

  请注意此配置项的值 不同于 在 macOS 上被用作通用二进制 wheel 的标识符。 请参阅 Python 打包用户指南了解有关 在 macOS 上使用的打包平台兼容性标签 的详情

--with-framework-name=FRAMEWORK

  为 macOS 中的 python 框架指定名称，仅当设置了 `--enable-framework` 时有效（默认：`Python`）。

--with-app-store-compliance

--with-app-store-compliance=PATCH-FILE

  Python 标准库包含已知的当提交给 macOS 和 iOS 应用商店进行发布时会触发自动检查工具错误的字符串。 如果启用，该选项将应用已知可纠正应用商店合规性的补丁列表。 也可以指定自定义补丁文件。 在默认情况下将禁用此选项。

  Added in version 3.13.

### 3.3.14. iOS 选项

参见 iOS/README.rst。

--enable-framework=INSTALLDIR

  创建一个 Python 框架。 不同于 macOS，指定安装路径的 INSTALLDIR 参数是强制性的。

--with-framework-name=FRAMEWORK

  指定框架的名称 (默认名称: `Python`)。

### 3.3.15. 交叉编译选项

交叉编译，或称交叉构建，可被用于为不同的 CPU 架构或平台构建 Python。 交叉编译需要一个针对构建平台的 Python 解释器。 构建的 Python 版本必须与交叉编译的主机 Python 版本相匹配。

--build=BUILD

  用于在 BUILD 上执行构建的配置，通常由 config.guess 通过推测得到。

--host=HOST

  交叉编译以构建在 HOST (目标平台) 上运行的程序

--with-build-python=path/to/python

  针对交叉编译构建 `python` 二进制文件的路径

  Added in version 3.11.

CONFIG_SITE=file

  指向一个带有配置重载的的文件的环境变量。

  示例 config.site 文件：

      # config.site-aarch64
      ac_cv_buggy_getaddrinfo=no
      ac_cv_file__dev_ptmx=yes
      ac_cv_file__dev_ptc=no

HOSTRUNNER

  用于针对交叉编译主机平台的运行 CPython 的程序。

  Added in version 3.11.

交叉编译示例:

    CONFIG_SITE=config.site-aarch64 ../configure \
        --build=x86_64-pc-linux-gnu \
        --host=aarch64-unknown-linux-gnu \
        --with-build-python=../x86_64/python

## 3.4. Python 构建系统

### 3.4.1. 构建系统的主要文件

- `configure.ac` => `configure`;

- `Makefile.pre.in` => `Makefile` (由 `configure` 创建);

- `pyconfig.h` (由 `configure` 创建);

- `Modules/Setup`: 由Makefile 使用 `Module/makesetup` shell 脚本构建的 C 扩展;

### 3.4.2. 主要构建步骤

- C文件（ `.c` ）是作为对象文件（ `.o` ）构建的。

- 一个静态库 `libpython` （ `.a` ）是由对象文件创建的。

- `python.o` 和静态库 `libpython` 被链接到最终程序 `python` 中。

- C 扩展是由 Makefile 构建的 (参见 `Modules/Setup`)。

### 3.4.3. 主要 Makefile 目标

#### 3.4.3.1. make

对于大部分情况来说，当编译某段代码或从上游刷新你的签出内容之后重新构建时，你需要做的就是执行 `make`，它（按照 Make 的语义）将构建默认目标，即在 Makefile 中定义的第一个目标。 在传统上（包括在 CPython 项目中）这通常为 `all` 目标。 `configure` 脚本将扩展一个 `autoconf` 变量 `@DEF_MAKE_ALL_RULE@` 来准确地描述 `make all` 将构建哪个目标。 有如下三个选择：

- `profile-opt` (使用 `--enable-optimizations` 配置)

- `build_wasm` (如果主机平台匹配``wasm32-wasi*``或``wasm32-emscripten``，则选择)

- `build_all` (不显式地使用任何其他配置)

根据最近的源文件更改，Make 将重新构建任何尚未被更新的目标（对象文件和可执行文件），包括在必要时再次运行 `configure`。 不过源/目标的依赖项数量很多并且是手动维护的，因此 Make 有时并没有所需的全部信息来正确地检测所有需要重新构建的目标。 根据尚未被重新构建的目标的具体情况，你可能会遇到许多问题。 如果你有无法确定原理的构建或测试问题，`make clean && make` 应该能够解决大多数依赖问题，代价则是会耗费更多的时间来构建。

#### 3.4.3.2. make platform

构建 `python` 程序，但不构造标准库扩展模块。 这将生成一个名为 `platform` 的文件，其中只包含一行描述构建平台详细信息的文本，例如 `macosx-14.3-arm64-3.12` 或 `linux-x86_64-3.13`。

#### 3.4.3.3. make profile-opt

使用 profile-guided optimization (PGO) 构建 Python。 你可以使用 `--enable-optimizations` 配置选项来使其成为 `make` 命令的默认目标（即对应 `make all` 或更简洁的 `make` 命令）。

#### 3.4.3.4. make clean

移除已构建文件。

#### 3.4.3.5. make distclean

在 `make clean` 所做的工作之外，还移除由配置脚本所创建的文件。 再次构建之前将需要运行 `configure`。 [6]

#### 3.4.3.6. make install

构建 `all` 目标并安装 Python。

#### 3.4.3.7. make test

构建``all``目标，并使用不带GUI测试的``--fast-ci``选项运行Python测试套件。变量：

- `TESTOPTS`: 额外的回归测试命令行选项。

- `TESTPYTHONOPTS`: 额外的 Python 命令行选项。

- `TESTTIMEOUT`: 超时限制（默认值：10 分钟）。

#### 3.4.3.8. make ci

这与 `make test` 类似，但还会使用 `-ugui` 来运行 GUI 测试。

Added in version 3.14.

#### 3.4.3.9. make buildbottest

这与 `make test` 类似，但会使用默认超时限制为 20 分钟的 `--slow-ci` 选项，而不是 `--fast-ci` 选项。

#### 3.4.3.10. make regen-all

重新生成（几乎）所有的已生成文件。 这包括（但不限于）字节码用例，以及解析器生成器文件。 对于其余的 已生成文件 必须分别运行 `make regen-stdlib-module-names` 和 `autoconf`。

### 3.4.4. C 扩展

有些 C 扩展是作为内置模块构建的，比如 `sys` 模块。 它们在定义了 `Py_BUILD_CORE_BUILTIN` 宏的情况下构建。 内置模块没有 `__file__` 属性：

    >>> import sys
    >>> sys
    <module 'sys' (built-in)>
    >>> sys.__file__
    Traceback (most recent call last):
      File "<stdin>", line 1, in <module>
    AttributeError: module 'sys' has no attribute '__file__'

其他 C 扩展是作为动态库来构建的，比如 `_asyncio` 模块。 它们在定义了 `Py_BUILD_CORE_MODULE` 宏的情况下构建。 在 Linux x86-64 上的例子：

    >>> import _asyncio
    >>> _asyncio
    <module '_asyncio' from '/usr/lib64/python3.9/lib-dynload/_asyncio.cpython-39-x86_64-linux-gnu.so'>
    >>> _asyncio.__file__
    '/usr/lib64/python3.9/lib-dynload/_asyncio.cpython-39-x86_64-linux-gnu.so'

`Modules/Setup` 用于生成 Makefile 目标，以构建 C 扩展。在文件的开头， C 被构建为内置模块。在标记 `*shared*` 之后定义的扩展被构建为动态库。

宏 `PyAPI_FUNC()`, `PyAPI_DATA()` 和 `PyMODINIT_FUNC` 在 `Include/exports.h` 中的定义将因是否定义了 `Py_BUILD_CORE_MODULE` 宏而不同:

- 如果 `Py_BUILD_CORE_MODULE` 定义了，使用 `Py_EXPORTED_SYMBOL` 。

- 否则使用 `Py_IMPORTED_SYMBOL` 。

如果宏 `Py_BUILD_CORE_BUILTIN` 被错误地用在作为共享库构建的 C 扩展上，它的 `PyInit_xxx()` 函数就不会被导出，导致导入时出现 `ImportError` 。

## 3.5. 编译器和链接器的标志

脚本 `./configure` 和环境变量设置的选项，并被 `Makefile` 使用。

### 3.5.1. 预处理器的标志

CONFIGURE_CPPFLAGS

  变量 `CPPFLAGS` 的值被传递给 `./configure` 脚本。

  Added in version 3.6.

CPPFLAGS

  (Objective) C/C++ 预处理器标志，例如，如果头文件位于非标准的目录 include_dir 中，请使用 `-Iinclude_dir` 。

  `CPPFLAGS` 和 `LDFLAGS` 都需要包含 shell 的值以便能够使用环境变量中指定的目录构建扩展模块。

BASECPPFLAGS

  Added in version 3.4.

PY_CPPFLAGS

  为构建解释器对象文件增加了额外的预处理器标志。

  默认为： `$(BASECPPFLAGS) -I. -I$(srcdir)/Include $(CONFIGURE_CPPFLAGS) $(CPPFLAGS)` 。

  Added in version 3.2.

### 3.5.2. 编译器标志

CC

  C 编译器指令。

  例如： `gcc -pthread` 。

CXX

  C++ 编译器指令。

  例如： `g++ -pthread` 。

CFLAGS

  C 编译器标志。

CFLAGS_NODIST

  `CFLAGS_NODIST` 用于构建解释器和 stdlib C 扩展。 一旦装好 Python 则当某个编译器旗标 不应 成为 `CFLAGS` 的一部分时将可使用它 (gh-65320)。

  特别地，`CFLAGS` 不应当包含:

  - 编译器旗标 `-I` (用于为包括文件设置搜索路径)。 `-I` 旗标将按从左到右的顺序处理，并且 `CFLAGS` 中的任何旗标都将优先于 user- 和 package- 层级所提供的 `-I` 旗标。

  - 加固旗标如 `-Werror` 因为分发版无法控制由用户安装的包是否符合这样的高标准。

  Added in version 3.5.

COMPILEALL_OPTS

  当在 `make install` 中构建 PYC 文件时传给 `compileall` 命令行的选项。 默认值: `-j0`。

  Added in version 3.12.

EXTRA_CFLAGS

  而外的 C 编译器指令。

CONFIGURE_CFLAGS

  变量 `CFLAGS` 的值传递给 `./configure` 脚本。

  Added in version 3.2.

CONFIGURE_CFLAGS_NODIST

  变量 `CFLAGS_NODIST` 的值传递给 `./configure` 脚本。

  Added in version 3.5.

BASECFLAGS

  基础编译器标志。

OPT

  优化标志。

CFLAGS_ALIASING

  严格或不严格的别名标志，用于编译 `Python/dtoa.c` 、

  Added in version 3.7.

CCSHARED

  用于构建共享库的编译器标志。

  例如， `-fPIC` 在 Linux 和 BSD 上使用。

CFLAGSFORSHARED

  为构建解释器对象文件增加了额外的 C 标志。

  ，默认为： `$(CCSHARED)` ，当 `--enable-shared` 被使用时，则为空字符串

PY_CFLAGS

  默认为： `$(BASECFLAGS) $(OPT) $(CONFIGURE_CFLAGS) $(CFLAGS) $(EXTRA_CFLAGS)` 。

PY_CFLAGS_NODIST

  默认为： `$(CONFIGURE_CFLAGS_NODIST) $(CFLAGS_NODIST) -I$(srcdir)/Include/internal` 。

  Added in version 3.5.

PY_STDMODULE_CFLAGS

  用于构建解释器对象文件的 C 标志。

  默认为： `$(PY_CFLAGS) $(PY_CFLAGS_NODIST) $(PY_CPPFLAGS) $(CFLAGSFORSHARED)`。

  Added in version 3.7.

PY_CORE_CFLAGS

  默认为 `$(PY_STDMODULE_CFLAGS) -DPy_BUILD_CORE` 。

  Added in version 3.2.

PY_BUILTIN_MODULE_CFLAGS

  编译器标志，将标准库的扩展模块作为内置模块来构建，如 `posix` 模块

  默认为： `$(PY_STDMODULE_CFLAGS) -DPy_BUILD_CORE_BUILTIN` 。

  Added in version 3.8.

PURIFY

  Purify 命令。 Purify 是一个内存调试程序。

  默认为：空字符串（不使用）。

### 3.5.3. 链接器标志位

LINKCC

  用于构建如 `python` 和 `_testembed` 的程序的链接器命令。

  默认值: `$(PURIFY) $(CC)`。

CONFIGURE_LDFLAGS

  变量 `LDFLAGS` 的值被传递给 `./configure` 脚本。

  避免指定 `CFLAGS` ， `LDFLAGS` 等，这样用户就可以在命令行上使用它们来追加这些值，而不用触碰到预设的值。

  Added in version 3.2.

LDFLAGS_NODIST

  `LDFLAGS_NODIST` 的使用方式与 `CFLAGS_NODIST` 相同。 一旦装好 Python 则当某个链接器旗标 不应 成为 `LDFLAGS` 的一部分时将可使用它 (gh-65320)。

  特别地，`LDFLAGS` 不应当包含:

  - 编译器旗标 `-L` (用于为库设置搜索路径)。 `-L` 旗标将按从左到右的顺序处理，并且 `LDFLAGS` 中的任何旗标都将优先于 user- 和 package 层级所提供的 `-L` 旗标。

CONFIGURE_LDFLAGS_NODIST

  变量 `LDFLAGS_NODIST` 的值传递给 `./configure` 脚本。

  Added in version 3.8.

LDFLAGS

  链接器标志，例如，如果库位于非标准的目录 lib_dir 中，请使用 `-Llib_dir` 。

  `CPPFLAGS` 和 `LDFLAGS` 都需要包含 shell 的值以便能够使用环境变量中指定的目录构建扩展模块。

LIBS

  链接器标志，在链接 Python 可执行文件时将库传递给链接器。

  例如： `-lrt` 。

LDSHARED

  构建一个共享库的命令。

  默认为： `@LDSHARED@ $(PY_LDFLAGS)` 。

BLDSHARED

  构建共享库 `libpython` 的命令。

  默认为： `@BLDSHARED@ $(PY_CORE_LDFLAGS)` 。

PY_LDFLAGS

  默认为： `$(CONFIGURE_LDFLAGS) $(LDFLAGS)` 。

PY_LDFLAGS_NODIST

  默认为： `$(CONFIGURE_LDFLAGS_NODIST) $(LDFLAGS_NODIST)` 。

  Added in version 3.8.

PY_CORE_LDFLAGS

  用于构建解释器对象文件的链接器标志。

  Added in version 3.8.

备注

[6]

`git clean -fdx` 是“清理”你的签出内容的更激进方式。 它将移除所有对 Git 来说未知的文件。 当使用 `git bisect` 查找程序错误时，推荐在多次探查之间 执行此命令来确保完整的全新构建。 请谨慎使用，因为它将删除所有未签入 Git 的文件，包括你最新的、尚未提交的工作。