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)

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

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

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

Python::Interpreter

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

Python::InterpreterDebug

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

Отладочный интерпретатор Python. Эта цель определена только если найден компонент Interpreter и переменная Python_EXECUTABLE_DEBUG определена. Цель определена только на платформе Windows.

Python::InterpreterMultiConfig

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

Интерпретатор 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.

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

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

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

Python_FOUND

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

Python_Interpreter_FOUND

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

Python_EXECUTABLE

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

Python_EXECUTABLE_DEBUG

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

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

Python_INTERPRETER

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

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

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_DEFINITIONS

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

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

Python_DEBUG_POSTFIX

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

Python_LINK_OPTIONS

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

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

Python_LIBRARIES

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

Python_LIBRARY_DIRS

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

Python_RUNTIME_LIBRARY_DIRS

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

Python_SABI_LIBRARIES

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

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

Python_SABI_LIBRARY_DIRS

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

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

Python_RUNTIME_SABI_LIBRARY_DIRS

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

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

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 представляет собой 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 (Python_FIND_ABI "ON" "ANY" "ANY" "ON")

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

И чтобы найти все возможные ABI:

set (Python_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).

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.

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