FindPython

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

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

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

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

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

  • Development.Module: поиск артефактов для разработки модулей Python.
  • Development.Embed: поиск артефактов для разработки встраивания Python.
• 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::Python

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

Python::NumPy

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

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

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

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

Python_FOUND

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

Python_Interpreter_FOUND

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

Python_EXECUTABLE

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

Python_INTERPRETER_ID

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

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

Python_STDLIB

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

Информация, возвращаемая distutils.sysconfig.get_python_lib(plat_specific=False,standard_lib=True), или иначе sysconfig.get_path('stdlib').

Python_STDARCH

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

Информация, возвращаемая distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=True), или иначе sysconfig.get_path('platstdlib').

Python_SITELIB

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

Информация, возвращаемая distutils.sysconfig.get_python_lib(plat_specific=False,standard_lib=False), или иначе sysconfig.get_path('purelib').

Python_SITEARCH

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

Информация, возвращаемая distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=False), или иначе sysconfig.get_path('platlib').

Python_SOABI

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

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

Информация, возвращаемая distutils.sysconfig.get_config_var('SOABI'), или вычисляется из distutils.sysconfig.get_config_var('EXT_SUFFIX') или python-config --extension-suffix. Если пакет distutils.sysconfig недоступен, используются sysconfig.get_config_var('SOABI') или sysconfig.get_config_var('EXT_SUFFIX').

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

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

Python_COMPILER

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

Python_DOTNET_LAUNCHER

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

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

Python_LIBRARY

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

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

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