# 3. 配置 Python

## 3.1. 建置需求

要建置 CPython，你將需要：

- 一個 C11 編譯器。選擇性 C11 功能並非必要。

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

- 支援 IEEE 754 浮點數與浮點數非數值 (NaN)。

- thread 的支援。

在 3.5 版的變更: 在 Windows 上現在需要 Visual Studio 2015 或更新版本。

在 3.6 版的變更: Selected C99 features, like `<stdint.h>` and `static inline` functions, are now required.

在 3.7 版的變更: 執行緒支援現在是必要的。

在 3.11 版的變更: 現在需要 C11 編譯器、IEEE 754 和 NaN 支援。在 Windows 上需要 Visual Studio 2017 或更新版本。

See also PEP 7 "Style Guide for C Code" and PEP 11 "CPython platform support".

### 3.1.1. 可選模組的需求

Some optional modules of the standard library require third-party libraries installed for development (for example, header files must be available).

Missing requirements are reported in the `configure` output. Modules that are missing due to missing dependencies are listed near the end of the `make` output, sometimes using an internal name, for example, `_ctypes` for `ctypes` module.

If you distribute a CPython interpreter without optional modules, it's best practice to advise users, who generally expect that standard library modules are available.

建置可選模組的依賴項目為：

Dependency | Minimum version | Python 模組
--- | --- | ---
libbz2 |  | `bz2`
libffi | 建議使用 3.3.0 版本 | `ctypes`
liblzma |  | `lzma`
libmpdec | 2.5.0 | `decimal` [1]
libreadline 或 libedit [2] |  | `readline`
libuuid |  | `_uuid` [3]
ncurses [4] |  | `curses`
OpenSSL | 3.0.18 recommended (1.1.1 minimum) | `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]

If libmpdec is not available, the `decimal` module will use a pure-Python implementation. See `--with-system-libmpdec` for details.

[2]

See `--with-readline` for choosing the backend for the `readline` module.

[3]

The `uuid` module uses `_uuid` to generate "safe" UUIDs. See the module documentation for details.

[4]

The `curses` module requires the `libncurses` or `libncursesw` library. The `curses.panel` module additionally requires the `libpanel` or `libpanelw` library.

[5]

If OpenSSL is not available, the `hashlib` module will use bundled implementations of several hash functions. See `--with-builtin-hashlib-hashes` for forcing usage of OpenSSL.

Note that the table does not include all optional modules; in particular, platform-specific modules like `winreg` are not listed here.

也參考

- The devguide includes a full list of dependencies required to build all modules and instructions on how to install them on common platforms.

- `--with-system-expat` allows building with an external libexpat library.

- Options for third-party dependencies

在 3.1 版的變更: `tkinter` 現在需要 Tcl/Tk version 8.3.1。

在 3.5 版的變更: `tkinter` 現在需要 Tcl/Tk version 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 version 8.5.12。

在 3.13 版的變更: `sqlite3` 現在會需要 SQLite 3.15.2。

## 3.2. 產生的檔案

To reduce build dependencies, Python source code contains multiple generated files. Commands to regenerate all generated files:

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

The `Makefile.pre.in` file documents generated files, their inputs, and tools used to regenerate them. Search for `regen-*` make targets.

### 3.2.1. 設定腳本

The `make regen-configure` command regenerates the `aclocal.m4` file and the `configure` script using the `Tools/build/regen-configure.sh` shell script which uses an Ubuntu container to get the same tools versions and have a reproducible output.

The container is optional, the following command can be run locally:

    autoreconf -ivf -Werror

The generated files can change depending on the exact versions of the tools used. The container that CPython uses has Autoconf 2.72, `aclocal` from Automake 1.16.5, and pkg-config 1.8.1.

在 3.13 版的變更: Autoconf 2.71 and aclocal 1.16.5 and are now used to regenerate `configure`.

在 3.14 版的變更: 現在使用 Autoconf 2.72 來重新產生 `configure`。

## 3.3. 設定選項

使用以下命令列出所有 `configure` 腳本選項：

    ./configure --help

請見 Python 原始碼發行版中的 `Misc/SpecialBuilds.txt`。

### 3.3.1. 一般選項

--enable-loadable-sqlite-extensions

  Support loadable extensions in the `_sqlite` extension module (default is no) of the `sqlite3` module.

  請見 `sqlite3` 模組的 `sqlite3.Connection.enable_load_extension()` 方法。

  在 3.6 版被加入.

--disable-ipv6

  停用 IPv6 支援（如果支援的話預設是啟用的），請見 `socket` 模組。

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

  Define the size in bits of Python `int` digits: 15 or 30 bits.

  By default, the digit size is 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`. See the Compile-time configuration of the `zoneinfo` module.

  預設值：`/usr/share/zoneinfo:/usr/lib/zoneinfo:/usr/share/lib/zoneinfo:/etc/zoneinfo`。

  請見 `os.pathsep` 路徑分隔符號。

  在 3.9 版被加入.

--without-decimal-contextvar

  Build the `_decimal` extension module using a thread-local context rather than a coroutine-local context (default), see the `decimal` module.

  請見 `decimal.HAVE_CONTEXTVAR` 與 `contextvars` 模組。

  在 3.9 版被加入.

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

  Override order to check db backends for the `dbm` module

  A valid value is a colon (`:`) separated string with the backend names:

  - `ndbm`;

  - `gdbm`;

  - `bdb`.

--without-c-locale-coercion

  Disable C locale coercion to a UTF-8 based locale (enabled by default).

  不要定義 `PY_COERCE_C_LOCALE` 巨集。

  請見 `PYTHONCOERCECLOCALE` 與 PEP 538。

--with-platlibdir=DIRNAME

  Python 函式庫目錄名稱（預設為 `lib` ）。

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

  參閱 `sys.platlibdir`。

  在 3.9 版被加入.

--with-wheel-pkg-dir=PATH

  Directory of wheel packages used by the `ensurepip` module (none by default).

  Some Linux distribution packaging policies recommend against bundling dependencies. For example, Fedora installs wheel packages in the `/usr/share/python-wheels/` directory and don't install the `ensurepip._bundled` package.

  在 3.10 版被加入.

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

  Whether configure should use pkg-config to detect build dependencies.

  - `check`（預設）：pkg-config 是可選的

  - `yes`：pkg-config 是必要的

  - `no`：即使存在也不使用 pkg-config 來配置

  在 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",
      }

  在 3.15 版被加入.

--enable-pystats

  Turn on internal Python performance statistics gathering.

  By default, statistics gathering is off. Use `python3 -X pystats` command or set `PYTHONSTATS=1` environment variable to turn on statistics gathering at Python startup.

  At Python exit, dump statistics if statistics gathering was on and not cleared.

  效果：

  - 新增 `-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` 來讀取統計資料。

  Statistics:

  - Opcode:

    - Specialization: success, failure, hit, deferred, miss, deopt, failures;

    - Execution count;

    - Pair count.

  - Call:

    - Inlined Python calls;

    - PyEval calls;

    - Frames pushed;

    - Frame object created;

    - Eval calls: vector, generator, legacy, function VECTORCALL, build class, slot, function "ex", API, method.

  - 物件：

    - incref and decref;

    - interpreter incref and decref;

    - allocations: all, 512 bytes, 4 kiB, big;

    - free;

    - to/from free lists;

    - dictionary materialized/dematerialized;

    - type cache;

    - 最佳化嘗試；

    - optimization traces created/executed;

    - uops executed.

  - 垃圾回收器：

    - 垃圾回收；

    - Objects visited;

    - Objects collected.

  在 3.11 版被加入.

--disable-gil

  Enables support for running Python without the global interpreter lock (GIL): free-threaded build.

  Defines the `Py_GIL_DISABLED` macro and adds `"t"` to `sys.abiflags`.

  細節請參見 Free-threaded CPython。

  在 3.13 版被加入.

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

  Indicate how to integrate the experimental just-in-time compiler.

  - `no`: Don't build the JIT.

  - `yes`: Enable the JIT. To disable it at runtime, set the environment variable `PYTHON_JIT=0`.

  - `yes-off`: Build the JIT, but disable it by default. To enable it at runtime, set the environment variable `PYTHON_JIT=1`.

  - `interpreter`: Enable the "JIT interpreter" (only useful for those debugging the JIT itself). To disable it at runtime, set the environment variable `PYTHON_JIT=0`.

  `--enable-experimental-jit=no` is the default behavior if the option is not provided, and `--enable-experimental-jit` is shorthand for `--enable-experimental-jit=yes`. See `Tools/jit/README.md` for more information, including how to install the necessary build-time dependencies.

  備註

  When building CPython with JIT enabled, ensure that your system has Python 3.11 or later installed.

  在 3.13 版被加入.

PKG_CONFIG

  Path to `pkg-config` utility.

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. Linker options

LDFLAGS

  Linker flags, e.g. `-Llibrary_directory`.

LIBS

  Libraries to pass to the linker, e.g. `-llibrary`.

MACHDEP

  Name for machine-dependent library files.

### 3.3.4. Options for third-party dependencies

在 3.11 版被加入.

BZIP2_CFLAGS

BZIP2_LIBS

  C compiler and linker flags to link Python to `libbz2`, used by `bz2` module, overriding `pkg-config`.

CURSES_CFLAGS

CURSES_LIBS

  C compiler and linker flags for `libncurses` or `libncursesw`, used by `curses` module, overriding `pkg-config`.

GDBM_CFLAGS

GDBM_LIBS

  C compiler and linker flags for `gdbm`.

LIBEDIT_CFLAGS

LIBEDIT_LIBS

  C compiler and linker flags for `libedit`, used by `readline` module, overriding `pkg-config`.

LIBFFI_CFLAGS

LIBFFI_LIBS

  C compiler and linker flags for `libffi`, used by `ctypes` module, overriding `pkg-config`.

LIBMPDEC_CFLAGS

LIBMPDEC_LIBS

  C compiler and linker flags for `libmpdec`, used by `decimal` module, overriding `pkg-config`.

  備註

  These environment variables have no effect unless `--with-system-libmpdec` is specified.

LIBLZMA_CFLAGS

LIBLZMA_LIBS

  C compiler and linker flags for `liblzma`, used by `lzma` module, overriding `pkg-config`.

LIBREADLINE_CFLAGS

LIBREADLINE_LIBS

  C compiler and linker flags for `libreadline`, used by `readline` module, overriding `pkg-config`.

LIBSQLITE3_CFLAGS

LIBSQLITE3_LIBS

  C compiler and linker flags for `libsqlite3`, used by `sqlite3` module, overriding `pkg-config`.

LIBUUID_CFLAGS

LIBUUID_LIBS

  C compiler and linker flags for `libuuid`, used by `uuid` module, overriding `pkg-config`.

LIBZSTD_CFLAGS

LIBZSTD_LIBS

  C compiler and linker flags for `libzstd`, used by `compression.zstd` module, overriding `pkg-config`.

  在 3.14 版被加入.

PANEL_CFLAGS

PANEL_LIBS

  C compiler and linker flags for PANEL, overriding `pkg-config`.

  C compiler and linker flags for `libpanel` or `libpanelw`, used by `curses.panel` module, overriding `pkg-config`.

TCLTK_CFLAGS

TCLTK_LIBS

  C compiler and linker flags for TCLTK, overriding `pkg-config`.

ZLIB_CFLAGS

ZLIB_LIBS

  C compiler and linker flags for `libzlib`, used by `gzip` module, overriding `pkg-config`.

### 3.3.5. WebAssembly 選項

--enable-wasm-dynamic-linking

  Turn on dynamic linking support for WASM.

  Dynamic linking enables `dlopen`. File size of the executable increases due to limited dead code elimination and additional features.

  在 3.11 版被加入.

--enable-wasm-pthreads

  Turn on pthreads support for WASM.

  在 3.11 版被加入.

### 3.3.6. 安裝選項

--prefix=PREFIX

  Install architecture-independent files in PREFIX. On Unix, it defaults to `/usr/local`.

  這個值可以在 runtime 使用 `sys.prefix` 取得。

  As an example, one can use `--prefix="$HOME/.local/"` to install a Python in its home directory.

--exec-prefix=EPREFIX

  Install architecture-dependent files in EPREFIX, defaults to `--prefix`.

  這個值可以在 runtime 使用 `sys.exec_prefix` 取得

--disable-test-modules

  Don't build nor install test modules, like the `test` package or the `_testcapi` extension module (built and installed by default).

  在 3.10 版被加入.

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

  選擇在 Python 安裝時執行的 `ensurepip` 命令：

  - `upgrade` （預設）：執行 `python -m ensurepip --altinstall --upgrade` 命令。

  - `install`：執行 `python -m ensurepip --altinstall` 命令；

  - `no`：不要執行 ensurepip；

  在 3.6 版被加入.

### 3.3.7. 效能選項

Configuring Python using `--enable-optimizations --with-lto` (PGO + LTO) is recommended for best performance. The experimental `--enable-bolt` flag can also be used to improve performance.

--enable-optimizations

  Enable Profile Guided Optimization (PGO) using `PROFILE_TASK` (disabled by default).

  The C compiler Clang requires `llvm-profdata` program for PGO. On macOS, GCC also requires it: GCC is just an alias to Clang on macOS.

  Disable also semantic interposition in libpython if `--enable-shared` and GCC is used: add `-fno-semantic-interposition` to the compiler and linker flags.

  備註

  During the build, you may encounter compiler warnings about profile data not being available for some source files. These warnings are harmless, as only a subset of the code is exercised during profile data acquisition. To disable these warnings on Clang, manually suppress them by adding `-Wno-profile-instr-unprofiled` to `CFLAGS`.

  在 3.6 版被加入.

  在 3.10 版的變更: 在 GCC 上使用 `-fno-semantic-interposition`。

PROFILE_TASK

  Environment variable used in the Makefile: Python command line arguments for the PGO generation task.

  預設值：`-m test --pgo --timeout=$(TESTTIMEOUT)`。

  在 3.8 版被加入.

  在 3.13 版的變更: Task failure is no longer ignored silently.

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

  Enable Link Time Optimization (LTO) in any build (disabled by default).

  The C compiler Clang requires `llvm-ar` for LTO (`ar` on macOS), as well as an LTO-aware linker (`ld.gold` or `lld`).

  在 3.6 版被加入.

  在 3.11 版被加入: To use ThinLTO feature, use `--with-lto=thin` on Clang.

  在 3.12 版的變更: Use ThinLTO as the default optimization policy on Clang if the compiler accepts the flag.

--enable-bolt

  Enable usage of the BOLT post-link binary optimizer (disabled by default).

  BOLT is part of the LLVM project but is not always included in their binary distributions. This flag requires that `llvm-bolt` and `merge-fdata` are available.

  BOLT is still a fairly new project so this flag should be considered experimental for now. Because this tool operates on machine code its success is dependent on a combination of the build environment + the other optimization configure args + the CPU architecture, and not all combinations are supported. BOLT versions before LLVM 16 are known to crash BOLT under some scenarios. Use of LLVM 16 or newer for BOLT optimization is strongly encouraged.

  The `BOLT_INSTRUMENT_FLAGS` and `BOLT_APPLY_FLAGS` configure variables can be defined to override the default set of arguments for llvm-bolt to instrument and apply BOLT data to binaries, respectively.

  在 3.12 版被加入.

BOLT_APPLY_FLAGS

  Arguments to `llvm-bolt` when creating a BOLT optimized binary.

  在 3.12 版被加入.

BOLT_INSTRUMENT_FLAGS

  Arguments to `llvm-bolt` when instrumenting binaries.

  在 3.12 版被加入.

--with-computed-gotos

  Enable computed gotos in evaluation loop (enabled by default on supported compilers).

--with-tail-call-interp

  Enable interpreters using tail calls in CPython. If enabled, enabling PGO (`--enable-optimizations`) is highly recommended. This option specifically requires a C compiler with proper tail call support, and the preserve_none calling convention. For example, Clang 19 and newer supports this feature.

  在 3.14 版被加入.

--without-mimalloc

  Disable the fast mimalloc allocator (enabled by default).

  另請參閱 `PYTHONMALLOC` 環境變數。

--without-pymalloc

  Disable the specialized Python memory allocator pymalloc (enabled by default).

  另請參閱 `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.

  在 3.15 版被加入.

--without-doc-strings

  Disable static documentation strings to reduce the memory footprint (enabled by default). Documentation strings defined in Python are not affected.

  不要定義 `WITH_DOC_STRINGS` 巨集。

  請見 `PyDoc_STRVAR()` 巨集。

--enable-profiling

  Enable C-level code profiling with `gprof` (disabled by default).

--with-strict-overflow

  Add `-fstrict-overflow` to the C compiler flags (by default we add `-fno-strict-overflow` instead).

--without-remote-debug

  Deactivate remote debugging support described in PEP 768 (enabled by default). When this flag is provided the code that allows the interpreter to schedule the execution of a Python file in a separate process as described in PEP 768 is not compiled. This includes both the functionality to schedule code to be executed and the functionality to receive code to be executed.

  Py_REMOTE_DEBUG

    This macro is defined by default, unless Python is configured with `--without-remote-debug`.

    Note that even if the macro is defined, remote debugging may not be available (for example, on an incompatible platform).

  在 3.14 版被加入.

### 3.3.8. Python Debug Build

A debug build is Python built with the `--with-pydebug` configure option.

Effects of a debug build:

- Display all warnings by default: the list of default warning filters is empty in the `warnings` module.

- 新增 `d` 到 `sys.abiflags`。

- 新增 `sys.gettotalrefcount()` 函式。

- 新增 `-X showrefcount` 命令列選項。

- Add `-d` command line option and `PYTHONDEBUG` environment variable to debug the parser.

- Add support for the `__lltrace__` variable: enable low-level tracing in the bytecode evaluation loop if the variable is defined.

- Install debug hooks on memory allocators to detect buffer overflow and other memory errors.

- 定義 `Py_DEBUG` 和 `Py_REF_DEBUG` 巨集。

- Add runtime checks: code surrounded by `#ifdef Py_DEBUG` and `#endif`. Enable `assert(...)` and `_PyObject_ASSERT(...)` assertions: don't set the `NDEBUG` macro (see also the `--with-assertions` configure option). Main runtime checks:

  - Add sanity checks on the function arguments.

  - Unicode and int objects are created with their memory filled with a pattern to detect usage of uninitialized objects.

  - Ensure that functions which can clear or replace the current exception are not called with an exception raised.

  - Check that deallocator functions don't change the current exception.

  - The garbage collector (`gc.collect()` function) runs some basic checks on objects consistency.

  - The `Py_SAFE_DOWNCAST()` macro checks for integer underflow and overflow when downcasting from wide types to narrow types.

See also the Python Development Mode and the `--with-trace-refs` configure option.

在 3.8 版的變更: Release builds and debug builds are now ABI compatible: defining the `Py_DEBUG` macro no longer implies the `Py_TRACE_REFS` macro (see the `--with-trace-refs` option).

### 3.3.9. 偵錯選項

--with-pydebug

  以偵錯模式建置 Python：定義 `Py_DEBUG` 巨集（預設不啟用）。

--with-trace-refs

  以偵錯為目的啟用參照追蹤（預設不啟用）。

  效果：

  - 定義 `Py_TRACE_REFS` 巨集。

  - 新增 `sys.getobjects()` 函式。

  - 新增 `PYTHONDUMPREFS` 環境變數。

  `PYTHONDUMPREFS` 環境變數可以用來在 Python 結束時轉儲仍然有效的物件和參照計數。

  不追蹤靜態配置的物件。

  在 3.8 版被加入.

  在 3.13 版的變更: 這個建置現在與發佈版本建置和偵錯建置具有 ABI 相容性。

--with-assertions

  啟用 C 斷言建置（預設不啟用）：`assert(...);` 和 `_PyObject_ASSERT(...);`。

  如果設定，`NDEBUG` 巨集不會在 `OPT` 編譯器變數中定義。

  另請參閱 `--with-pydebug` 選項（debug build），它也啟用了斷言。

  在 3.6 版被加入.

--with-valgrind

  啟用 Valgrind 支援（預設不啟用）。

--with-dtrace

  啟用 DTrace 支援（預設不啟用）。

  請參閱使用 DTrace 和 SystemTap 檢測 CPython。

  在 3.6 版被加入.

--with-address-sanitizer

  Enable AddressSanitizer memory error detector, `asan` (default is no). To improve ASan detection capabilities you may also want to combine this with `--without-pymalloc` to disable the specialized small-object allocator whose allocations are not tracked by ASan.

  在 3.6 版被加入.

--with-memory-sanitizer

  啟用 MemorySanitizer 分配錯誤偵測器 `msan`（預設不啟用）。

  在 3.6 版被加入.

--with-undefined-behavior-sanitizer

  啟用 UndefinedBehaviorSanitizer 未定義行為偵測器 `ubsan`（預設不啟用）。

  在 3.6 版被加入.

--with-thread-sanitizer

  啟用 ThreadSanitizer 資料競爭偵測器 `tsan`（預設不啟用）。

  在 3.13 版被加入.

### 3.3.10. Linker options

--enable-shared

  啟用建置共享 Python 函式庫：`libpython`（預設不啟用）。

--without-static-libpython

  不要建置 `libpythonMAJOR.MINOR.a` 並且不要安裝 `python.o`（預設會建置並啟用）。

  在 3.10 版被加入.

### 3.3.11. 函式庫選項

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

  Link against additional libraries (default is no).

--with-system-expat

  使用已安裝的 `expat` 函式庫建置 `pyexpat` 模組（預設不建置）。

--with-system-libmpdec

  使用已安裝的 `mpdecimal` 函式庫建置 `_decimal` 擴充模組，請參閱 `decimal` 模組（預設建置）。

  在 3.3 版被加入.

  在 3.13 版的變更: 預設使用已安裝的 `mpdecimal` 函式庫。

  在 3.15 版的變更: A bundled copy of the library will no longer be selected implicitly if an installed `mpdecimal` library is not found. In Python 3.15 only, it can still be selected explicitly using `--with-system-libmpdec=no` or `--without-system-libmpdec`.

  自從版本 3.13 後不推薦使用，將會自版本 3.16 中移除。: Python 3.16 不再隨附 `mpdecimal` 函式庫的原始碼副本。

  也參考

  `LIBMPDEC_CFLAGS` 和 `LIBMPDEC_LIBS`。

--with-readline=readline|editline

  Designate a backend library for the `readline` module.

  - readline: Use readline as the backend.

  - editline: Use editline as the backend.

  在 3.10 版被加入.

--without-readline

  不要建置 `readline` 模組（預設會建置）。

  不要定義 `HAVE_LIBREADLINE` 巨集。

  在 3.10 版被加入.

--with-libm=STRING

  Override `libm` math library to STRING (default is system-dependent).

--with-libc=STRING

  Override `libc` C library to STRING (default is system-dependent).

--with-openssl=DIR

  OpenSSL 目錄的根目錄。

  在 3.7 版被加入.

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

  Set runtime library directory (rpath) for OpenSSL libraries:

  - `no` (default): don't set rpath;

  - `auto`: auto-detect rpath from `--with-openssl` and `pkg-config`;

  - DIR: set an explicit rpath.

  在 3.10 版被加入.

### 3.3.12. 安全性選項

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

  Select hash algorithm for use in `Python/pyhash.c`:

  - `siphash13`（預設）；

  - `siphash24`；

  - `fnv`。

  在 3.4 版被加入.

  在 3.11 版被加入: `siphash13` is added and it is the new default.

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

  內建雜湊模組：

  - `md5`；

  - `sha1`；

  - `sha256`；

  - `sha512`；

  - `sha3` (with shake);

  - `blake2`。

  在 3.9 版被加入.

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

  Override the OpenSSL default cipher suites string:

  - `python` (default): use Python's preferred selection;

  - `openssl`: leave OpenSSL's defaults untouched;

  - STRING: use a custom string

  請見 `ssl` 模組。

  在 3.7 版被加入.

  在 3.10 版的變更: The settings `python` and STRING also set TLS 1.2 as minimum protocol version.

--disable-safety

  Disable compiler options that are recommended by OpenSSF for security reasons with no performance overhead. If this option is not enabled, CPython will be built based on safety compiler options with no slow down. When this option is enabled, CPython will not be built with the compiler options listed below.

  The following compiler options are disabled with `--disable-safety`:

  - -fstack-protector-strong: Enable run-time checks for stack-based buffer overflows.

  - -Wtrampolines: Enable warnings about trampolines that require executable stacks.

  在 3.14 版被加入.

--enable-slower-safety

  Enable compiler options that are recommended by OpenSSF for security reasons which require overhead. If this option is not enabled, CPython will not be built based on safety compiler options which performance impact. When this option is enabled, CPython will be built with the compiler options listed below.

  The following compiler options are enabled with `--enable-slower-safety`:

  - -D_FORTIFY_SOURCE=3: Fortify sources with compile- and run-time checks for unsafe libc usage and buffer overflows.

  在 3.14 版被加入.

### 3.3.13. macOS 選項

參閱 Mac/README.rst。

--enable-universalsdk

--enable-universalsdk=SDKDIR

  Create a universal binary build. SDKDIR specifies which macOS SDK should be used to perform the build (default is no).

--enable-framework

--enable-framework=INSTALLDIR

  Create a Python.framework rather than a traditional Unix install. Optional INSTALLDIR specifies the installation path (default is no).

--with-universal-archs=ARCH

  Specify the kind of universal binary that should be created. This option is only valid when `--enable-universalsdk` is set.

  選項：

  - `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）。

  Note that values for this configuration item are not the same as the identifiers used for universal binary wheels on macOS. See the Python Packaging User Guide for details on the packaging platform compatibility tags used on macOS

--with-framework-name=FRAMEWORK

  Specify the name for the python framework on macOS only valid when `--enable-framework` is set (default: `Python`).

--with-app-store-compliance

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

  The Python standard library contains strings that are known to trigger automated inspection tool errors when submitted for distribution by the macOS and iOS App Stores. If enabled, this option will apply the list of patches that are known to correct app store compliance. A custom patch file can also be specified. This option is disabled by default.

  在 3.13 版被加入.

### 3.3.14. iOS 選項

參閱 iOS/README.rst。

--enable-framework=INSTALLDIR

  Create a Python.framework. Unlike macOS, the INSTALLDIR argument specifying the installation path is mandatory.

--with-framework-name=FRAMEWORK

  指定框架的名稱（預設值：`Python`）。

### 3.3.15. Cross Compiling Options

Cross compiling, also known as cross building, can be used to build Python for another CPU architecture or platform. Cross compiling requires a Python interpreter for the build platform. The version of the build Python must match the version of the cross compiled host Python.

--build=BUILD

  configure for building on BUILD, usually guessed by config.guess.

--host=HOST

  cross-compile to build programs to run on HOST (target platform)

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

  path to build `python` binary for cross compiling

  在 3.11 版被加入.

CONFIG_SITE=file

  An environment variable that points to a file with configure overrides.

  範例 config.site 檔案：

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

HOSTRUNNER

  Program to run CPython for the host platform for cross-compilation.

  在 3.11 版被加入.

Cross compiling example:

    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`: C extensions built by the Makefile using `Module/makesetup` shell script;

### 3.4.2. 主要建置步驟

- C 檔案（`.c`）被建置為目的檔（`.o`）。

- A static `libpython` library (`.a`) is created from objects files.

- `python.o` and the static `libpython` library are linked into the final `python` program.

- C extensions are built by the Makefile (see `Modules/Setup`).

### 3.4.3. 主要 Makefile 目標

#### 3.4.3.1. make

For the most part, when rebuilding after editing some code or refreshing your checkout from upstream, all you need to do is execute `make`, which (per Make's semantics) builds the default target, the first one defined in the Makefile. By tradition (including in the CPython project) this is usually the `all` target. The `configure` script expands an `autoconf` variable, `@DEF_MAKE_ALL_RULE@` to describe precisely which targets `make all` will build. The three choices are:

- `profile-opt`（使用 `--enable-optimizations` 配置）

- `build_wasm` (chosen if the host platform matches `wasm32-wasi*` or `wasm32-emscripten`)

- `build_all`（未明確使用其他選項進行配置）

Depending on the most recent source file changes, Make will rebuild any targets (object files and executables) deemed out-of-date, including running `configure` again if necessary. Source/target dependencies are many and maintained manually however, so Make sometimes doesn't have all the information necessary to correctly detect all targets which need to be rebuilt. Depending on which targets aren't rebuilt, you might experience a number of problems. If you have build or test problems which you can't otherwise explain, `make clean && make` should work around most dependency problems, at the expense of longer build times.

#### 3.4.3.2. make platform

Build the `python` program, but don't build the standard library extension modules. This generates a file named `platform` which contains a single line describing the details of the build platform, e.g., `macosx-14.3-arm64-3.12` or `linux-x86_64-3.13`.

#### 3.4.3.3. make profile-opt

Build Python using profile-guided optimization (PGO). You can use the configure `--enable-optimizations` option to make this the default target of the `make` command (`make all` or just `make`).

#### 3.4.3.4. make clean

移除建置的檔案。

#### 3.4.3.5. make distclean

In addition to the work done by `make clean`, remove files created by the configure script. `configure` will have to be run before building again. [6]

#### 3.4.3.6. make install

建置 `all` 目標並安裝 Python。

#### 3.4.3.7. make test

Build the `all` target and run the Python test suite with the `--fast-ci` option without GUI tests. Variables:

- `TESTOPTS`：額外的 regrtest 命令列選項。

- `TESTPYTHONOPTS`：額外的 Python 命令列選項。

- `TESTTIMEOUT`：秒數表示的超時設定（預設值：10 分鐘）。

#### 3.4.3.8. make ci

This is similar to `make test`, but uses the `-ugui` to also run GUI tests.

在 3.14 版被加入.

#### 3.4.3.9. make buildbottest

This is similar to `make test`, but uses the `--slow-ci` option and default timeout of 20 minutes, instead of `--fast-ci` option.

#### 3.4.3.10. make regen-all

Regenerate (almost) all generated files. These include (but are not limited to) bytecode cases, and parser generator file. `make regen-stdlib-module-names` and `autoconf` must be run separately for the remaining generated files.

### 3.4.4. C 擴充模組

Some C extensions are built as built-in modules, like the `sys` module. They are built with the `Py_BUILD_CORE_BUILTIN` macro defined. Built-in modules have no `__file__` attribute:

    >>> 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__'

Other C extensions are built as dynamic libraries, like the `_asyncio` module. They are built with the `Py_BUILD_CORE_MODULE` macro defined. Example on 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` is used to generate Makefile targets to build C extensions. At the beginning of the files, C extensions are built as built-in modules. Extensions defined after the `*shared*` marker are built as dynamic libraries.

The `PyAPI_FUNC()`, `PyAPI_DATA()` and `PyMODINIT_FUNC` macros of `Include/exports.h` are defined differently depending if the `Py_BUILD_CORE_MODULE` macro is defined:

- 如果定義了 `Py_BUILD_CORE_MODULE`，則使用 `Py_EXPORTED_SYMBOL`

- 否則使用 `Py_IMPORTED_SYMBOL`。

If the `Py_BUILD_CORE_BUILTIN` macro is used by mistake on a C extension built as a shared library, its `PyInit_xxx()` function is not exported, causing an `ImportError` on import.

## 3.5. Compiler and linker flags

Options set by the `./configure` script and environment variables and used by `Makefile`.

### 3.5.1. 預處理器旗標

CONFIGURE_CPPFLAGS

  Value of `CPPFLAGS` variable passed to the `./configure` script.

  在 3.6 版被加入.

CPPFLAGS

  (Objective) C/C++ preprocessor flags, e.g. `-Iinclude_dir` if you have headers in a nonstandard directory include_dir.

  Both `CPPFLAGS` and `LDFLAGS` need to contain the shell's value to be able to build extension modules using the directories specified in the environment variables.

BASECPPFLAGS

  在 3.4 版被加入.

PY_CPPFLAGS

  Extra preprocessor flags added for building the interpreter object files.

  Default: `$(BASECPPFLAGS) -I. -I$(srcdir)/Include $(CONFIGURE_CPPFLAGS) $(CPPFLAGS)`.

  在 3.2 版被加入.

### 3.5.2. 編譯器旗標

CC

  C 編譯器指令。

  範例：`gcc -pthread`。

CXX

  C++ 編譯器指令。

  範例：`g++ -pthread`。

CFLAGS

  C 編譯器旗標。

CFLAGS_NODIST

  `CFLAGS_NODIST` is used for building the interpreter and stdlib C extensions. Use it when a compiler flag should not be part of `CFLAGS` once Python is installed (gh-65320).

  In particular, `CFLAGS` should not contain:

  - the compiler flag `-I` (for setting the search path for include files). The `-I` flags are processed from left to right, and any flags in `CFLAGS` would take precedence over user- and package-supplied `-I` flags.

  - hardening flags such as `-Werror` because distributions cannot control whether packages installed by users conform to such heightened standards.

  在 3.5 版被加入.

COMPILEALL_OPTS

  Options passed to the `compileall` command line when building PYC files in `make install`. Default: `-j0`.

  在 3.12 版被加入.

EXTRA_CFLAGS

  額外的 C 編譯器旗標。

CONFIGURE_CFLAGS

  Value of `CFLAGS` variable passed to the `./configure` script.

  在 3.2 版被加入.

CONFIGURE_CFLAGS_NODIST

  Value of `CFLAGS_NODIST` variable passed to the `./configure` script.

  在 3.5 版被加入.

BASECFLAGS

  基本編譯器旗標。

OPT

  最佳化旗標。

CFLAGS_ALIASING

  Strict or non-strict aliasing flags used to compile `Python/dtoa.c`.

  在 3.7 版被加入.

CCSHARED

  用於建置共享函式庫的編譯器旗標。

  例如說 `-fPIC` 被使用於 Linux 與 BSD 上。

CFLAGSFORSHARED

  用於建置直譯器目的檔的額外 C 旗標。

  預設值：當使用 `--enable-shared` 時為 `$(CCSHARED)`，否則為空字串。

PY_CFLAGS

  預設值：`$(BASECFLAGS) $(OPT) $(CONFIGURE_CFLAGS) $(CFLAGS) $(EXTRA_CFLAGS)`。

PY_CFLAGS_NODIST

  預設值：`$(CONFIGURE_CFLAGS_NODIST) $(CFLAGS_NODIST) -I$(srcdir)/Include/internal`。

  在 3.5 版被加入.

PY_STDMODULE_CFLAGS

  用於建置直譯器目的檔的 C 旗標。

  預設值：`$(PY_CFLAGS) $(PY_CFLAGS_NODIST) $(PY_CPPFLAGS) $(CFLAGSFORSHARED)`。

  在 3.7 版被加入.

PY_CORE_CFLAGS

  預設值：`$(PY_STDMODULE_CFLAGS) -DPy_BUILD_CORE`。

  在 3.2 版被加入.

PY_BUILTIN_MODULE_CFLAGS

  Compiler flags to build a standard library extension module as a built-in module, like the `posix` module.

  預設值：`$(PY_STDMODULE_CFLAGS) -DPy_BUILD_CORE_BUILTIN`。

  在 3.8 版被加入.

PURIFY

  Purify command. Purify is a memory debugger program.

  預設值：空字串（未使用）。

### 3.5.3. Linker flags

LINKCC

  Linker command used to build programs like `python` and `_testembed`.

  預設值：`$(PURIFY) $(CC)`。

CONFIGURE_LDFLAGS

  Value of `LDFLAGS` variable passed to the `./configure` script.

  Avoid assigning `CFLAGS`, `LDFLAGS`, etc. so users can use them on the command line to append to these values without stomping the pre-set values.

  在 3.2 版被加入.

LDFLAGS_NODIST

  `LDFLAGS_NODIST` is used in the same manner as `CFLAGS_NODIST`. Use it when a linker flag should not be part of `LDFLAGS` once Python is installed (gh-65320).

  In particular, `LDFLAGS` should not contain:

  - the compiler flag `-L` (for setting the search path for libraries). The `-L` flags are processed from left to right, and any flags in `LDFLAGS` would take precedence over user- and package-supplied `-L` flags.

CONFIGURE_LDFLAGS_NODIST

  Value of `LDFLAGS_NODIST` variable passed to the `./configure` script.

  在 3.8 版被加入.

LDFLAGS

  Linker flags, e.g. `-Llib_dir` if you have libraries in a nonstandard directory lib_dir.

  Both `CPPFLAGS` and `LDFLAGS` need to contain the shell's value to be able to build extension modules using the directories specified in the environment variables.

LIBS

  Linker flags to pass libraries to the linker when linking the Python executable.

  範例：`-lrt`。

LDSHARED

  建置共享函式庫的指令。

  預設值：`@LDSHARED@ $(PY_LDFLAGS)`。

BLDSHARED

  建置 `libpython` 共享函式庫的指令。

  預設值：`@BLDSHARED@ $(PY_CORE_LDFLAGS)`。

PY_LDFLAGS

  預設值：`$(CONFIGURE_LDFLAGS) $(LDFLAGS)`。

PY_LDFLAGS_NODIST

  預設值：`$(CONFIGURE_LDFLAGS_NODIST) $(LDFLAGS_NODIST)`。

  在 3.8 版被加入.

PY_CORE_LDFLAGS

  Linker flags used for building the interpreter object files.

  在 3.8 版被加入.

註腳

[6]

`git clean -fdx` is an even more extreme way to "clean" your checkout. It removes all files not known to Git. When bug hunting using `git bisect`, this is recommended between probes to guarantee a completely clean build. Use with care, as it will delete all files not checked into Git, including your new, uncommitted work.