FindPython

Поиск интерпретатора Python, компилятора и среды разработки (каталоги заголовков и библиотеки).

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

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

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

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

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

  Новое в версии 3.26:

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

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

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

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

find_package (Python COMPONENTS Interpreter Development)

Этот модуль предпочтительно ищет версию 3 Python. Если не найдена, ищется версия 2. Для управления одновременными версиями 3 и 2 Python используйте модули FindPython3 и FindPython2, а не этот.

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

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

Python::Interpreter

Интерпретатор Python. Цель определена, если найден компонент Interpreter.

Python::Compiler

Компилятор Python. Цель определена, если найден компонент Compiler.

Python::Module

Новое в версии 3.15.

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

Python::SABIModule

Новое в версии 3.26.

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

Python::Python

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

Python::NumPy

Новое в версии 3.14.

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

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

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

Python_FOUND

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

Python_Interpreter_FOUND

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

Python_EXECUTABLE

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

Python_INTERPRETER_ID

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

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

Python_STDLIB

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

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

Python_STDARCH

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

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

Python_SITELIB

Внеплатформенный каталог установки стороннего ПО.

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

Python_SITEARCH

Зависимый от платформы каталог установки стороннего ПО.

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

Python_SOABI

Новое в версии 3.17.

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

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

Python_SOSABI

Новое в версии 3.26.

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

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

Python_Compiler_FOUND

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

Python_COMPILER

Путь к компилятору Python. Доступно только для IronPython.

Python_COMPILER_ID

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

• IronPython

Python_DOTNET_LAUNCHER

Новое в версии 3.18.

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

Python_Development_FOUND

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

Python_Development.Module_FOUND

Новое в версии 3.18.

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

Python_Development.SABIModule_FOUND

Новое в версии 3.26.

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

Python_Development.Embed_FOUND

Новое в версии 3.18.

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

Python_INCLUDE_DIRS

Каталоги заголовков Python.

Python_LINK_OPTIONS

Новое в версии 3.19.

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

Python_LIBRARIES

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

Python_LIBRARY_DIRS

Каталоги библиотек Python.

Python_RUNTIME_LIBRARY_DIRS

Каталоги библиотек времени выполнения Python.

Python_SABI_LIBRARIES

Новое в версии 3.26.

Библиотеки Python для Stable Application Binary Interface.

Python_SABI_LIBRARY_DIRS

Новое в версии 3.26.

Каталоги библиотек SABI Python.

Python_RUNTIME_SABI_LIBRARY_DIRS

Новое в версии 3.26.

Каталоги библиотек времени выполнения SABI Python.

Python_VERSION

Версия Python.

Python_VERSION_MAJOR

Главная версия Python.

Python_VERSION_MINOR

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

Python_VERSION_PATCH

Версия Python (патч).

Python_PyPy_VERSION

Новое в версии 3.18.

Версия Python PyPy.

Python_NumPy_FOUND

Новое в версии 3.14.

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

Python_NumPy_INCLUDE_DIRS

Новое в версии 3.14.

Каталоги заголовков NumPy.

Python_NumPy_VERSION

Новое в версии 3.14.

Версия NumPy.

Подсказки

Python_ROOT_DIR

Определяет корневую директорию установки Python.

Python_USE_STATIC_LIBS

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

Примечание

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

Python_FIND_ABI

Новое в версии 3.16.

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

Примечание

Этот параметр будет учтён только при поиске Python версии 3.

Примечание

Если Python_FIND_ABI не определено, будет произведён поиск любого ABI.

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

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

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

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

set (Python_FIND_ABI "ON" "ANY" "ANY")

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

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

set (Python_FIND_ABI "ANY" "ANY" "ANY")

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

Примечание

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

Python_FIND_STRATEGY

Новое в версии 3.15.

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

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

См. также Python_FIND_UNVERSIONED_NAMES.

Python_FIND_REGISTRY

Новое в версии 3.13.

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

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

Python_FIND_FRAMEWORK

Новое в версии 3.15.

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

Примечание

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

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

Python_FIND_VIRTUALENV

Новое в версии 3.15.

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

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

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

Примечание

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

Python_FIND_IMPLEMENTATIONS

Новое в версии 3.18.

Эта переменная определяет, в порядке очереди, различные реализации, которые будут происканы. Переменная Python_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, может быть выбран, потому что, например, с Python_FIND_STRATEGY=LOCATION, каждое расположение будет сначала проверяться на наличие IronPython, а затем на наличие CPython.

Примечание

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

Python_FIND_UNVERSIONED_NAMES

Новое в версии 3.20.

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

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

См. также Python_FIND_STRATEGY.

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

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

Python_EXECUTABLE

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

Python_COMPILER

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

Python_DOTNET_LAUNCHER

Введено в версии 3.18.

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

Python_LIBRARY

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

Python_SABI_LIBRARY

Введено в версии 3.26.

Путь к библиотеке для стабильного API приложений. Будет использоваться для вычисления переменных Python_SABI_LIBRARIES, Python_SABI_LIBRARY_DIRS и Python_RUNTIME_SABI_LIBRARY_DIRS.

Python_INCLUDE_DIR

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

Python_NumPy_INCLUDE_DIR

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

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

Python_ARTIFACTS_INTERACTIVE

Введено в версии 3.18.

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

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

Команды

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

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

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