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::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_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_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 для Stable Application Binary Interface.

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 не определено, будет проверен любой ABI.

Переменная Python3_FIND_ABI представляет собой кортеж из 3 элементов, указывающих в том порядке pydebug (d), pymalloc (m) и unicode (u) флаги. Каждый элемент может быть установлен в одно из следующих значений:

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

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

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

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

Следующие комбинации флагов будут добавлены в имена артефактов в указанном порядке: dmu, dm, du, и d.

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

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

Будут использованы следующие комбинации в указанном порядке: mu, m, u, <empty>, dmu, dm, du и d.

Примечание

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

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.