FindPython

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

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

• 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

Библиотека 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

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

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

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

А для обработки любых возможных ABIs:

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_LIBRAY_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, если таковое имеется.