FindPython3

Найти интерпретатор, компилятор и среду разработки Python 3 (включая каталоги заголовочных файлов и библиотеки).

Поддерживаются следующие компоненты:

• Interpreter: поиск интерпретатора Python 3
• Compiler: поиск компилятора Python 3. Предлагается только IronPython.

• Development: поиск артефактов разработки (каталоги заголовочных файлов и библиотеки).

  Добавлен в версии 3.18: Этот компонент включает два подкомпонента, которые можно указать независимо:

  • Development.Module: поиск артефактов для разработки модулей Python 3.
  • Development.Embed: поиск артефактов для разработки встраивания Python 3.

  Добавлен в версии 3.26:

  • Development.SABIModule: поиск артефактов для разработки модулей Python 3 с использованием Stable Application Binary Interface. Этот компонент доступен только для версии 3.2 и выше.
• NumPy: поиск каталогов заголовочных файлов NumPy.

Если не указаны COMPONENTS, предполагается Interpreter.

Если указан компонент Development, это подразумевает подкомпоненты Development.Module и Development.Embed.

Чтобы обеспечить согласованность версий между компонентами Interpreter, Compiler, Development (или одним из его подкомпонентов) и NumPy, укажите все компоненты одновременно:

find_package (Python3 COMPONENTS Interpreter Development)

Этот модуль ищет только версии 3 Python. Этот модуль можно использовать совместно с модулем FindPython2 для использования обеих версий Python.

Модуль FindPython можно использовать, если версия Python не важна.

Импортированные цели

Этот модуль определяет следующие импортированные цели:

Python3::Interpreter

Интерпретатор Python 3. Эта цель определена только при обнаружении компонента Interpreter.

Python3::InterpreterDebug

Добавлен в версии 3.30.

Отладочный интерпретатор Python 3. Эта цель определена только при обнаружении компонента Interpreter и определении переменной Python3_EXECUTABLE_DEBUG. Цель определена только на платформе Windows.

Python3::InterpreterMultiConfig

Добавлен в версии 3.30.

Интерпретатор Python 3. Используется версия интерпретатора релиз или отладка, в зависимости от контекста (платформа, конфигурация). Эта цель определена только при обнаружении компонента Interpreter.

Python3::Compiler

Компилятор Python 3. Эта цель определена только при обнаружении компонента Compiler.

Python3::Module

Добавлен в версии 3.15.

Библиотека Python 3 для модуля Python. Цель определена, если найден компонент Development.Module.

Python3::SABIModule

Добавлен в версии 3.26.

Библиотека Python 3 для модуля Python с использованием Stable Application Binary Interface. Цель определена, если найден компонент Development.SABIModule.

Python3::Python

Библиотека Python 3 для встраивания Python. Цель определена, если найден компонент Development.Embed.

Python3::NumPy

Добавлен в версии 3.14.

Библиотека NumPy для Python 3. Цель определена, если найден компонент NumPy.

Переменные результатов

Этот модуль установит следующие переменные в вашем проекте (см. Стандартные имена переменных):

Python3_FOUND

Система имеет запрошенные компоненты Python 3.

Python3_Interpreter_FOUND

Система имеет интерпретатор Python 3.

Python3_EXECUTABLE

Путь к интерпретатору Python 3.

Python3_EXECUTABLE_DEBUG

Добавлен в версии 3.30.

Путь к отладочному интерпретатору Python 3. Определяется только на платформе Windows.

Python3_INTERPRETER

Добавлен в версии 3.30.

Путь к интерпретатору Python 3, определённый как generator expression выбирающий переменные Python3_EXECUTABLE или Python3_EXECUTABLE_DEBUG в зависимости от контекста (платформа, конфигурация).

Python3_INTERPRETER_ID

Короткая строка, уникальная для интерпретатора. Возможные значения:

• Python
• ActivePython
• Anaconda
• Canopy
• IronPython
• PyPy

Python3_STDLIB

Стандартный независимый от платформы каталог установки.

Информация, возвращаемая sysconfig.get_path('stdlib').

Python3_STDARCH

Стандартный зависимый от платформы каталог установки.

Информация, возвращаемая sysconfig.get_path('platstdlib').

Python3_SITELIB

Третьесторонний независимый от платформы каталог установки.

Информация, возвращаемая sysconfig.get_path('purelib').

Python3_SITEARCH

Третьесторонний зависимый от платформы каталог установки.

Информация, возвращаемая sysconfig.get_path('platlib').

Python3_SOABI

Добавлен в версии 3.17.

Суффикс расширения для модулей.

Информация, вычисляемая из sysconfig.get_config_var('EXT_SUFFIX') или sysconfig.get_config_var('SOABI') или python3-config --extension-suffix.

Python3_SOSABI

Добавлен в версии 3.26.

Суффикс расширения для модулей, использующих Stable Application Binary Interface.

Информация вычисляется из importlib.machinery.EXTENSION_SUFFIXES при указании компонента Interpreter. В противном случае расширение abi3, за исключением Windows, MSYS и CYGWIN, для которых это пустая строка.

Python3_Compiler_FOUND

Система имеет компилятор Python 3.

Python3_COMPILER

Путь к компилятору Python 3. Предлагается только IronPython.

Python3_COMPILER_ID

Короткая строка, уникальная для компилятора. Возможные значения:

• IronPython

Python3_DOTNET_LAUNCHER

Добавлен в версии 3.18.

Интерпретатор .Net. Используется только реализацией IronPython.

Python3_Development_FOUND

Система имеет артефакты разработки Python 3.

Python3_Development.Module_FOUND

Добавлен в версии 3.18.

Система имеет артефакты разработки Python 3 для модулей Python.

Python3_Development.SABIModule_FOUND

Добавлен в версии 3.26.

Система имеет артефакты разработки Python 3 для модулей Python с использованием Stable Application Binary Interface.

Python3_Development.Embed_FOUND

Добавлен в версии 3.18.

Система имеет артефакты разработки Python 3 для встраивания Python.

Python3_INCLUDE_DIRS

Каталоги заголовочных файлов Python 3.

Python3_DEFINITIONS

Добавлен в версии 3.30.3.

Определения препроцессора Python 3.

Python3_DEBUG_POSTFIX

Суффикс модуля отладки Python. Эта переменная может использоваться для определения целевого свойства DEBUG_POSTFIX.

Python3_LINK_OPTIONS

Добавлен в версии 3.19.

Параметры ссылок Python 3. Некоторые конфигурации требуют определённых параметров ссылок для правильной сборки и выполнения.

Python3_LIBRARIES

Библиотеки Python 3.

Python3_LIBRARY_DIRS

Директории библиотек Python 3.

Python3_RUNTIME_LIBRARY_DIRS

Директории библиотек времени выполнения Python 3.

Python3_SABI_LIBRARIES

Добавлен в версии 3.26.

Библиотеки Python 3 для стабильного интерфейса прикладных бинарных файлов.

Python3_SABI_LIBRARY_DIRS

Добавлен в версии 3.26.

Директории библиотек Python 3 SABI.

Python3_RUNTIME_SABI_LIBRARY_DIRS

Добавлен в версии 3.26.

Директории библиотек времени выполнения Python 3 SABI.

Python3_VERSION

Версия Python 3.

Python3_VERSION_MAJOR

Основная версия Python 3.

Python3_VERSION_MINOR

Дополнительная версия Python 3.

Python3_VERSION_PATCH

Версия исправления Python 3.

Python3_PyPy_VERSION

Добавлен в версии 3.18.

Версия PyPy Python 3.

Python3_NumPy_FOUND

Добавлен в версии 3.14.

Система имеет NumPy.

Python3_NumPy_INCLUDE_DIRS

Добавлен в версии 3.14.

Директории включения NumPy.

Python3_NumPy_VERSION

Добавлен в версии 3.14.

Версия NumPy.

Рекомендации

Python3_ROOT_DIR

Определите корневой каталог установки Python 3.

Python3_USE_STATIC_LIBS

• Если не определено, поиск общих библиотек и статических библиотек будет осуществляться в этом порядке.
• Если установлено в TRUE, поиск будет осуществляться только для статических библиотек.
• Если установлено в FALSE, поиск будет осуществляться только для общих библиотек.

Примечание

Этот совет будет проигнорирован на Windows , так как статические библиотеки недоступны на этой платформе.

Python3_FIND_ABI

Добавлен в версии 3.16.

Эта переменная определяет, какие ABI, как определено в PEP 3149, должны быть проверены.

Переменная Python3_FIND_ABI представляет собой 4-кортеж, задающий в таком порядке pydebug (d), pymalloc (m), unicode (u) и gil_disabled (t) флаги.

Добавлен в версии 3.30: Добавлен четвертый элемент, определяющий флаг gil_disabled (т.е. многопотоковый Python), который является необязательным. Если не указано, значение равно OFF.

Каждый элемент может быть установлен на одно из следующих значений:

• ON: Соответствующий флаг выбран.
• OFF: Соответствующий флаг не выбран.
• ANY: Будут проверены оба варианта (ON и OFF)

Примечание

Если Python3_FIND_ABI не определен, будет проверен любой ABI, за исключением флага gil_disabled.

Начиная с наиболее специализированных и заканчивая наиболее общими, из этого 4-кортежа будут проверяться различные ABI. Кроме того, когда ANY указан для pydebug и gil_disabled, версии debug и free threaded будут проверяться после версий non-debug и non-gil-disabled.

Например, если у нас есть:

set (Python3_FIND_ABI "ON" "ANY" "ANY" "ON")

Следующие комбинации флагов будут добавлены к именам артефактов в указанном порядке: tdmu, tdm, tdu, и td.

И для поиска всех возможных ABI:

set (Python3_FIND_ABI "ANY" "ANY" "ANY" "ANY")

В указанном порядке будут использоваться следующие комбинации: mu, m, u, <empty>, dmu, dm, du, d, tmu, tm, tu, t, tdmu, tdm, tdu, и td.

Примечание

Этот совет полезен только на POSIX системах, за исключением флага gil_disabled. Таким образом, на Windows системах, когда Python_FIND_ABI определен, дистрибутивы Python с сайта python.org будут найдены только если значение для каждого флага равно OFF или ANY за исключением четвёртого (gil_disabled).

Python3_FIND_STRATEGY

Добавлен в версии 3.15.

Эта переменная определяет, как будет выполняться поиск. Переменная Python3_FIND_STRATEGY может быть установлена на одно из следующих значений:

• VERSION: Попытаться найти последнюю версию во всех указанных местах. Это значение по умолчанию, если политика CMP0094 не определена или установлена в OLD.
• LOCATION: Прекратить поиск как только будет найдена версия, удовлетворяющая ограничениям по версии. Это значение по умолчанию, если политика CMP0094 установлена в NEW.

См. также Python3_FIND_UNVERSIONED_NAMES.

Python3_FIND_REGISTRY

Добавлен в версии 3.13.

В Windows переменная Python3_FIND_REGISTRY определяет порядок предпочтения между реестром и переменными среды. Переменная Python3_FIND_REGISTRY может быть установлена на одно из следующих значений:

• FIRST: Попытка использовать реестр перед переменными среды. Это значение по умолчанию.
• LAST: Попытка использовать реестр после переменных среды.
• NEVER: Никогда не пытаться использовать реестр.

Python3_FIND_FRAMEWORK

Добавлен в версии 3.15.

В macOS переменная Python3_FIND_FRAMEWORK определяет порядок предпочтения между компонентами пакетов в стиле Apple и в стиле Unix. Эта переменная может принимать те же значения, что и переменная CMAKE_FIND_FRAMEWORK.

Примечание

Значение ONLY не поддерживается, поэтому будет использоваться FIRST.

Если Python3_FIND_FRAMEWORK не определена, будет использоваться переменная CMAKE_FIND_FRAMEWORK, если она есть.

Python3_FIND_VIRTUALENV

Добавлен в версии 3.15.

Эта переменная определяет обработку виртуальных сред, управляемых virtualenv или conda. Она имеет значение только при активной виртуальной среде (т.е. после выполнения скрипта activate). В этом случае она имеет приоритет над переменными Python3_FIND_REGISTRY и CMAKE_FIND_FRAMEWORK. Переменная Python3_FIND_VIRTUALENV может быть установлена на одно из следующих значений:

• FIRST: Виртуальная среда используется перед другими стандартными путями поиска интерпретатора. Это значение по умолчанию.
• ONLY: Используется только виртуальная среда для поиска интерпретатора.
• STANDARD: Виртуальная среда не используется для поиска интерпретатора, но переменная среды PATH всегда учитывается. В этом случае переменная Python3_FIND_REGISTRY (Windows) или CMAKE_FIND_FRAMEWORK (macOS) может быть установлена со значением LAST или NEVER для выбора интерпретатора из виртуальной среды по умолчанию.

Добавлен в версии 3.17: Добавлена поддержка сред conda.

Примечание

Если запрашивается компонент Development, настоятельно рекомендуется также включить компонент Interpreter, чтобы получить ожидаемый результат.

Python3_FIND_IMPLEMENTATIONS

Добавлен в версии 3.18.

Эта переменная определяет, в упорядоченном списке, различные реализации, которые будут проверены. Переменная Python3_FIND_IMPLEMENTATIONS может принимать следующие значения:

• CPython: Это стандартная реализация. Различные продукты, такие как Anaconda или ActivePython, полагаются на эту реализацию.
• IronPython: Эта реализация использует язык CSharp для .NET Framework поверх Dynamic Language Runtime (DLR). См. IronPython.
• PyPy: Эта реализация использует язык RPython и RPython translation toolchain для создания интерпретатора Python. См. PyPy.

Значение по умолчанию:

• Платформа Windows: CPython, IronPython
• Другие платформы: CPython

Примечание

Этот совет имеет самый низкий приоритет из всех советов, поэтому, даже если, например, вы укажете IronPython первым, а CPython вторым, продукт Python, основанный на CPython, может быть выбран, потому что, например, с Python3_FIND_STRATEGY=LOCATION, каждое место будет сначала проверяться на IronPython и во-вторых на CPython.

Примечание

Когда IronPython указан, на платформах, отличных от Windows, ожидается, что интерпретатор .Net (т.е. команда mono ) будет доступен через переменную PATH.

Python3_FIND_UNVERSIONED_NAMES

Добавлен в версии 3.20.

Эта переменная определяет, как будут проверяться общие имена. В настоящее время она применяется только к общим именам интерпретатора, а именно python3 и python.

Переменная Python3_FIND_UNVERSIONED_NAMES может быть установлена на одно из следующих значений:

• FIRST: Общие имена проверяются перед более специализированными (например, python3.5).
• LAST: Общие имена проверяются после более специализированных. Это значение по умолчанию.
• NEVER: Общие имена вообще не проверяются.

См. также Python3_FIND_STRATEGY.

Спецификация артефактов

Для решения особых случаев можно напрямую указать артефакты, установив следующие переменные:

Python3_EXECUTABLE

Путь к интерпретатору.

Python3_COMPILER

Путь к компилятору.

Python3_DOTNET_LAUNCHER

Добавлен в версии 3.18.

Интерпретатор .Net. Используется только реализацией IronPython.

Python3_LIBRARY

Путь к библиотеке. Будет использоваться для вычисления переменных Python3_LIBRARIES, Python3_LIBRARY_DIRS и Python3_RUNTIME_LIBRARY_DIRS.

Python3_SABI_LIBRARY

Добавлен в версии 3.26.

Путь к библиотеке для стабильного API прикладных библиотек. Будет использоваться для вычисления переменных Python3_SABI_LIBRARIES, Python3_SABI_LIBRARY_DIRS и Python3_RUNTIME_SABI_LIBRARY_DIRS.

Python3_INCLUDE_DIR

Путь к каталогу заголовков Python. Будет использоваться для вычисления переменной Python3_INCLUDE_DIRS.

Python3_NumPy_INCLUDE_DIR

Путь к каталогу заголовков NumPy. Будет использоваться для вычисления переменной Python3_NumPy_INCLUDE_DIRS.

По умолчанию этот модуль поддерживает несколько вызовов в разных каталогах проекта с различными требованиями к версии/компоненту, обеспечивая при этом правильные и согласованные результаты для каждого вызова. Для поддержки этого поведения кэш CMake не используется традиционным способом, что может быть проблематично для интерактивного задания. Поэтому для включения интерактивного задания поведение модуля можно контролировать с помощью следующей переменной:

Python3_ARTIFACTS_INTERACTIVE

Добавлен в версии 3.18.

Выбирает поведение модуля. Это булева переменная:

• Если установлено TRUE, создаются записи в кэше CMake для указанных выше переменных артефактов, чтобы пользователи могли редактировать их интерактивно. Это отключает поддержку множества требований к версии/компоненту.
• Если установлено FALSE или не определено: Включается поддержка множества требований к версии/компоненту.

Команды

Этот модуль определяет команду Python3_add_library (когда CMAKE_ROLE равно PROJECT), которая имеет ту же семантику, что и add_library() и добавляет зависимость к цели Python3::Python, или, когда тип библиотеки MODULE, к цели Python3::Module или Python3::SABIModule (если указан параметр USE_SABI) и учитывает правила именования Python-модулей:

Python3_add_library (<name> [STATIC | SHARED | MODULE [USE_SABI <version>] [WITH_SOABI]]
                     <source1> [<source2> ...])

Если тип библиотеки не указан, предполагается MODULE.