FindPython

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

При запросе версии её можно указать как простое значение или диапазон. Подробное описание использования и возможностей диапазона версий см. в команде find_package().

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

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

• Development: поиск артефактов разработки (каталоги заголовков и библиотеки). Этот компонент включает два подкомпонента, которые можно указывать независимо:

  • 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, а не этот.

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

Этот модуль определяет следующие импортированные целевые объекты (когда CMAKE_ROLE равен PROJECT):

Python::Interpreter

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

Python::Compiler

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

Python::Module

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

Python::Python

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

Python::NumPy

Библиотека Python NumPy. Целевой объект определён, если найден компонент 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

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

Информация возвращается 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

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

Python_Development_FOUND

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

Python_Development.Module_FOUND

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

Python_Development.Embed_FOUND

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

Python_INCLUDE_DIRS

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

Python_LINK_OPTIONS

Опции компоновки 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

Версия Python PyPy.

Python_NumPy_FOUND

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

Python_NumPy_INCLUDE_DIRS

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

Python_NumPy_VERSION

Версия NumPy.

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

Python_ROOT_DIR

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

Python_USE_STATIC_LIBS

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

Python_FIND_ABI

Эта переменная определяет, какие 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

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

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

Python_FIND_REGISTRY

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

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

Python_FIND_FRAMEWORK

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

Примечание

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

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

Python_FIND_VIRTUALENV

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

Примечание

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

Python_FIND_IMPLEMENTATIONS

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

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

Python_COMPILER

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

Python_DOTNET_LAUNCHER

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

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

• Если установлено в 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.

Для типа библиотеки MODULE, если указан параметр WITH_SOABI, суффикс модуля будет включать значение Python_SOABI, если таковое имеется.