3. Налаштувати Python

3.1. Build Requirements

Features and minimum versions required to build CPython:

• A C11 compiler. Optional C11 features are not required.

• On Windows, Microsoft Visual Studio 2017 or later is required.

• Support for IEEE 754 floating-point numbers and floating-point Not-a-Number (NaN).

• Support for threads.

• OpenSSL 1.1.1 is the minimum version and OpenSSL 3.0.9 is the recommended minimum version for the ssl and hashlib extension modules.

• SQLite 3.15.2 for the sqlite3 extension module.

• Tcl/Tk 8.5.12 for the tkinter module.

• Autoconf 2.71 and aclocal 1.16.5 are required to regenerate the configure script.

Змінено в версії 3.1: Tcl/Tk version 8.3.1 is now required.

Змінено в версії 3.5: On Windows, Visual Studio 2015 or later is now required. Tcl/Tk version 8.4 is now required.

Змінено в версії 3.6: Selected C99 features are now required, like <stdint.h> and static inline functions.

Змінено в версії 3.7: Thread support and OpenSSL 1.0.2 are now required.

Змінено в версії 3.10: OpenSSL 1.1.1 is now required. Require SQLite 3.7.15.

Змінено в версії 3.11: C11 compiler, IEEE 754 and NaN support are now required. On Windows, Visual Studio 2017 or later is required. Tcl/Tk version 8.5.12 is now required for the tkinter module.

Змінено в версії 3.13: Autoconf 2.71, aclocal 1.16.5 and SQLite 3.15.2 are now required.

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

3.2. Generated files

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. configure script

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 autoconf-archive, aclocal and pkg-config versions.

3.3. Налаштувати параметри

List all configure script options using:

./configure --help

Дивіться також Misc/SpecialBuilds.txt у вихідному дистрибутиві Python.

3.3.1. Загальні параметри

--enable-loadable-sqlite-extensions

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

Перегляньте метод sqlite3.Connection.enable_load_extension() модуля sqlite3.

Added in version 3.6.

--disable-ipv6

Вимкніть підтримку IPv6 (увімкнено за замовчуванням, якщо підтримується), перегляньте модуль socket.

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

Визначте розмір у бітах цифр Python int: 15 або 30 біт.

By default, the digit size is 30.

Визначте PYLONG_BITS_IN_DIGIT як 15 або 30.

Див. sys.int_info.bits_per_digit.

--with-suffix=SUFFIX

Установіть для виконуваного файлу Python суфікс SUFFIX.

The default suffix is .exe on Windows and macOS (python.exe executable), .js on Emscripten node, .html on Emscripten browser, .wasm on WASI, and an empty string on other platforms (python executable).

Змінено в версії 3.11: The default suffix on WASM platform is one of .js, .html or .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.

Added in version 3.9.

--without-decimal-contextvar

Створіть модуль розширення _decimal, використовуючи локальний контекст потоку, а не локальний контекст співпрограми (за замовчуванням), дивіться модуль decimal.

See decimal.HAVE_CONTEXTVAR and the contextvars module.

Added in version 3.9.

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

Порядок перевизначення, щоб перевірити серверні частини бази даних для модуля dbm

Дійсним значенням є розділений двокрапкою (:) рядок із іменами серверної частини:

• ndbm;

• gdbm;

• bdb.

--without-c-locale-coercion

Вимкнути приведення локалі C до локалі на основі UTF-8 (увімкнено за умовчанням).

Не визначайте макрос PY_COERCE_C_LOCALE.

Перегляньте PYTHONCOERCECLOCALE і PEP 538.

--without-freelists

Disable all freelists except the empty tuple singleton.

Added in version 3.11.

--with-platlibdir=DIRNAME

Ім’я каталогу бібліотеки Python (за замовчуванням – lib).

Fedora та SuSE використовують lib64 на 64-розрядних платформах.

Перегляньте sys.platlibdir.

Added in version 3.9.

--with-wheel-pkg-dir=PATH

Каталог пакетів коліс, які використовуються модулем ensurepip (за умовчанням немає).

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.

Added in version 3.10.

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

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

• check (default): pkg-config is optional

• yes: pkg-config is mandatory

• no: configure does not use pkg-config even when present

Added in version 3.11.

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

Ефекти:

• Add -X pystats command line option.

• Add PYTHONSTATS environment variable.

• Define the Py_STATS macro.

• Add functions to the sys module:

  • sys._stats_on(): Turns on statistics gathering.

  • sys._stats_off(): Turns off statistics gathering.

  • sys._stats_clear(): Clears the statistics.

  • sys._stats_dump(): Dump statistics to file, and clears the statistics.

The statistics will be dumped to a arbitrary (probably unique) file in /tmp/py_stats/ (Unix) or C:\temp\py_stats\ (Windows). If that directory does not exist, results will be printed on stderr.

Use Tools/scripts/summarize_stats.py to read the stats.

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.

• Object:

  • 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 attempts;

  • optimization traces created/executed;

  • uops executed.

• Garbage collector:

  • Garbage collections;

  • Objects visited;

  • Objects collected.

Added in version 3.11.

--disable-gil

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

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

See Free-threaded CPython for more detail.

Added in version 3.13.

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

Indicate how to integrate the JIT compiler.

• no - build the interpreter without the JIT.

• yes - build the interpreter with the JIT.

• yes-off - build the interpreter with the JIT but disable it by default.

• interpreter - build the interpreter without the JIT, but with the tier 2 enabled interpreter.

By convention, --enable-experimental-jit is a shorthand for --enable-experimental-jit=yes.

Added in version 3.13.

PKG_CONFIG

Path to pkg-config utility.

PKG_CONFIG_LIBDIR

PKG_CONFIG_PATH

pkg-config options.

3.3.2. C compiler options

CC

Команда компілятора C.

CFLAGS

Прапори компілятора C.

CPP

C preprocessor command.

CPPFLAGS

C preprocessor flags, e.g. -Iinclude_dir.

3.3.3. Параметри компонувальника

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

Added in version 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.

LIBB2_CFLAGS

LIBB2_LIBS

C compiler and linker flags for libb2 (BLAKE2), used by hashlib module, overriding pkg-config.

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.

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 Options

--with-emscripten-target=[browser|node]

Set build flavor for wasm32-emscripten.

• browser (default): preload minimal stdlib, default MEMFS.

• node: NODERAWFS and pthread support.

Added in version 3.11.

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

Added in version 3.11.

--enable-wasm-pthreads

Turn on pthreads support for WASM.

Added in version 3.11.

3.3.6. Параметри встановлення

--prefix=PREFIX

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

This value can be retrieved at runtime using 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.

This value can be retrieved at runtime using 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).

Added in version 3.10.

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

Виберіть команду ensurepip, запущену під час встановлення Python:

• оновлення (за замовчуванням): запустіть команду python -m securepip --altinstall --upgrade.

• встановити: запустіть команду python -m securepip --altinstall;

• ні: не запускати securepip;

Added in version 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

Увімкніть керовану оптимізацію профілю (PGO) за допомогою PROFILE_TASK (вимкнено за умовчанням).

Компілятор C Clang вимагає програми llvm-profdata для PGO. У macOS GCC також вимагає цього: GCC — це просто псевдонім Clang у macOS.

Вимкніть також семантичне вставлення в libpython, якщо --enable-shared і GCC використовуються: додайте -fno-semantic-interposition до позначок компілятора та компонувальника.

Примітка

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.

Added in version 3.6.

Змінено в версії 3.10: Використовуйте -fno-semantic-interposition на GCC.

PROFILE_TASK

Змінна середовища, яка використовується в Makefile: аргументи командного рядка Python для завдання створення PGO.

За замовчуванням: -m test --pgo --timeout=$(TESTTIMEOUT).

Added in version 3.8.

Змінено в версії 3.13: Task failure is no longer ignored silently.

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

Увімкніть оптимізацію часу підключення (LTO) у будь-якій збірці (за умовчанням вимкнено).

Для компілятора C Clang потрібен llvm-ar для LTO (ar для macOS), а також компонувальник, що підтримує LTO (ld.gold або lld).

Added in version 3.6.

Added in version 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.

Added in version 3.12.

BOLT_APPLY_FLAGS

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

Added in version 3.12.

BOLT_INSTRUMENT_FLAGS

Arguments to llvm-bolt when instrumenting binaries.

Added in version 3.12.

--with-computed-gotos

Увімкнути обчислені gotos у циклі оцінки (увімкнено за замовчуванням у підтримуваних компіляторах).

--without-mimalloc

Disable the fast mimalloc allocator (enabled by default).

Дивіться також змінну середовища PYTHONMALLOC.

--without-pymalloc

Вимкніть спеціалізований розподільник пам’яті Python pymalloc (увімкнено за замовчуванням).

Дивіться також змінну середовища PYTHONMALLOC.

--without-doc-strings

Вимкніть статичні рядки документації, щоб зменшити обсяг пам’яті (увімкнено за замовчуванням). Це не впливає на рядки документації, визначені в Python.

Не визначайте макрос WITH_DOC_STRINGS.

Перегляньте макрос PyDoc_STRVAR().

--enable-profiling

Увімкніть профілювання коду рівня C за допомогою gprof (вимкнено за умовчанням).

--with-strict-overflow

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

3.3.8. Збірка налагодження Python

Збірка для налагодження — це Python, створений із параметром налаштування --with-pydebug.

Наслідки збірки налагодження:

• Відображати всі попередження за замовчуванням: список стандартних фільтрів попереджень порожній у модулі warnings.

• Додайте d до sys.abiflags.

• Add sys.gettotalrefcount() function.

• Додайте параметр командного рядка -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.

• Встановіть debug хуки на розподільники пам’яті, щоб виявити переповнення буфера та інші помилки пам’яті.

• Визначте макроси 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:

  • Додайте перевірку правильності аргументів функції.

  • Об’єкти Unicode та int створюються з пам’яттю, заповненою шаблоном для виявлення використання неініціалізованих об’єктів.

  • Переконайтеся, що функції, які можуть очистити або замінити поточний виняток, не викликаються з викликом виключення.

  • Check that deallocator functions don’t change the current exception.

  • Збирач сміття (gc.collect() функція) запускає деякі базові перевірки узгодженості об’єктів.

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

Дивіться також Режим розробки Python і параметр налаштування --with-trace-refs.

Змінено в версії 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.

The PYTHONDUMPREFS environment variable can be used to dump objects and reference counts still alive at Python exit.

Statically allocated objects are not traced.

Added in version 3.8.

Змінено в версії 3.13: This build is now ABI compatible with release build and debug build.

--with-assertions

Збірка з увімкненими твердженнями C (за замовчуванням ні): assert(...); і _PyObject_ASSERT(...);.

Якщо встановлено, макрос NDEBUG не визначено в змінній компілятора OPT.

Дивіться також опцію --with-pydebug (debug build), яка також вмикає твердження.

Added in version 3.6.

--with-valgrind

Увімкнути підтримку Valgrind (за замовчуванням ні).

--with-dtrace

Увімкнути підтримку DTrace (за замовчуванням ні).

Перегляньте Інструментування CPython за допомогою DTrace і SystemTap.

Added in version 3.6.

--with-address-sanitizer

Увімкнути детектор помилок пам’яті AddressSanitizer, 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

Enable ThreadSanitizer data race detector, tsan (default is no).

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

Build the pyexpat module using an installed expat library (default is no).

--with-system-libmpdec

Build the _decimal extension module using an installed mpdecimal library, see the decimal module (default is yes).

Added in version 3.3.

Змінено в версії 3.13: Default to using the installed mpdecimal library.

Deprecated since version 3.13, will be removed in version 3.15: A copy of the mpdecimal library sources will no longer be distributed with Python 3.15.

Дивись також

LIBMPDEC_CFLAGS and 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.

Added in version 3.10.

--without-readline

Не створюйте модуль readline (створено за замовчуванням).

Не визначайте макрос HAVE_LIBREADLINE.

Added in version 3.10.

--with-libm=STRING

Замінити математичну бібліотеку libm на STRING (за замовчуванням залежить від системи).

--with-libc=STRING

Замінити бібліотеку C libc на STRING (за замовчуванням залежить від системи).

--with-openssl=DIR

Корінь каталогу OpenSSL.

Added in version 3.7.

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

Встановити каталог бібліотеки середовища виконання (rpath) для бібліотек OpenSSL:

• ні (за замовчуванням): не встановлювати rpath;

• auto: автоматичне визначення rpath з --with-openssl і pkg-config;

• DIR: встановити явний rpath.

Added in version 3.10.

3.3.12. Параметри безпеки

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

Виберіть алгоритм хешування для використання в Python/pyhash.c:

• siphash13 (default);

• siphash24;

• fnv.

Added in version 3.4.

Added in version 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 (зі струшуванням);

• 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 як мінімальну версію протоколу.

3.3.13. Параметри macOS

See 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.

Опції:

• універсальний2;

• 32-розрядний;

• 64-розрядний;

• 3-сторонній;

• intel;

• intel-32;

• intel-64;

• все.

--with-framework-name=FRAMEWORK

Укажіть назву для фреймворку python у macOS, дійсну лише тоді, коли встановлено --enable-framework (за замовчуванням: 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.

Added in version 3.13.

3.3.14. iOS Options

See 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

Specify the name for the framework (default: 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

Added in version 3.11.

CONFIG_SITE=file

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

Example config.site file:

# 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.

Added in version 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, створені Makefile за допомогою сценарію оболонки Module/makesetup;

3.4.2. Основні етапи побудови

• Файли C (.c) створюються як об’єктні файли (.o).

• Статична бібліотека libpython (.a) створюється з файлів об’єктів.

• python.o і статична бібліотека libpython пов’язані в остаточну програму python.

• 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 (configured with --enable-optimizations)

• build_wasm (configured with --with-emscripten-target)

• build_all (configured without explicitly using either of the others)

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

Remove built files.

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. [1]

3.4.3.6. make install

Build the all target and install Python.

3.4.3.7. make test

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

• TESTOPTS: additional regrtest command-line options.

• TESTPYTHONOPTS: additional Python command-line options.

• TESTTIMEOUT: timeout in seconds (default: 10 minutes).

3.4.3.8. 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.9. 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 використовується для створення цілей Makefile для створення розширень C. На початку файлів розширення C побудовані як вбудовані модулі. Розширення, визначені після маркера *shared*, будуються як динамічні бібліотеки.

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_EXPORTED_SYMBOL, якщо Py_BUILD_CORE_MODULE визначено

• В іншому випадку використовуйте 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. Прапори компілятора та компонувальника

Параметри, встановлені сценарієм ./configure і змінними середовища та використовуються Makefile.

3.5.1. Прапори препроцесора

CONFIGURE_CPPFLAGS

Значення змінної CPPFLAGS передається до сценарію ./configure.

Added in version 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

Added in version 3.4.

PY_CPPFLAGS

Для побудови об’єктних файлів інтерпретатора додано додаткові позначки препроцесора.

Типове значення: $(BASECPPFLAGS) -I. -I$(srcdir)/Включити $(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 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.

Added in version 3.5.

COMPILEALL_OPTS

Options passed to the compileall command line when building PYC files in make install. Default: -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 — це програма для налагодження пам’яті.

За замовчуванням: порожній рядок (не використовується).

3.5.3. Прапори компонувальника

LINKCC

Команда компонувальника, яка використовується для створення таких програм, як python і _testembed.

Default: $(PURIFY) $(CC).

CONFIGURE_LDFLAGS

Значення змінної LDFLAGS передається до сценарію ./configure.

Уникайте призначення CFLAGS, LDFLAGS тощо, щоб користувачі могли використовувати їх у командному рядку для додавання до цих значень без порушення попередньо встановлених значень.

Added in version 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

Значення змінної LDFLAGS_NODIST передається до сценарію ./configure.

Added in version 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

Прапорці компонувальника для передачі бібліотек компонувальнику під час компонування виконуваного файлу 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.

Примітки

[1]

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.