FindPython3

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

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

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

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

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

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

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

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

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

find_package (Python3 COMPONENTS Interpreter Development)

Этот модуль ищет только версии Python 3. Этот модуль можно использовать совместно с модулем FindPython2 для использования обеих версий Python.

Модуль FindPython можно использовать, если версия Python не имеет значения.

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

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

Python3::Interpreter

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

Python3::Compiler

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

Python3::Module

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

Python3::Python

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

Python3::NumPy

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

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

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

Python3_FOUND

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

Python3_Interpreter_FOUND

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

Python3_EXECUTABLE

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

Python3_INTERPRETER_ID

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

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

Python3_STDLIB

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

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

Python3_STDARCH

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

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

Python3_SITELIB

Независимый от платформы каталог установки стороннего программного обеспечения.

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

Python3_SITEARCH

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

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

Python3_SOABI

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

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

Python3_Compiler_FOUND

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

Python3_COMPILER

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

Python3_COMPILER_ID

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

• IronPython

Python3_DOTNET_LAUNCHER

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

Python3_Development_FOUND

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

Python3_Development.Module_FOUND

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

Python3_Development.Embed_FOUND

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

Python3_INCLUDE_DIRS

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

Python3_LINK_OPTIONS

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

Python3_LIBRARIES

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

Python3_LIBRARY_DIRS

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

Python3_RUNTIME_LIBRARY_DIRS

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

Python3_VERSION

Версия Python 3.

Python3_VERSION_MAJOR

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

Python3_VERSION_MINOR

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

Python3_VERSION_PATCH

Версия исправления Python 3.

Python3_PyPy_VERSION

Версия PyPy Python 3.

Python3_NumPy_FOUND

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

Python3_NumPy_INCLUDE_DIRS

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

Python3_NumPy_VERSION

Версия NumPy.

Подсказки

Python3_ROOT_DIR

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

Python3_USE_STATIC_LIBS

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

Python3_FIND_ABI

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

Примечание

Если Python3_FIND_ABI не определена, будут проверены любые ABI.

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

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

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

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

set (Python3_FIND_ABI "ON" "ANY" "ANY")

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

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

set (Python3_FIND_ABI "ANY" "ANY" "ANY")

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

Примечание

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

Python3_FIND_STRATEGY

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

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

Python3_FIND_REGISTRY

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

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

Python3_FIND_FRAMEWORK

На macOS переменная Python3_FIND_FRAMEWORK определяет порядок предпочтения между компонентами пакетов в стиле Apple и стиле Unix. Эта переменная может принимать те же значения, что и переменная CMAKE_FIND_FRAMEWORK.

Примечание

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

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

Python3_FIND_VIRTUALENV

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

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

Примечание

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

Python3_FIND_IMPLEMENTATIONS

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

Примечание

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

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

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

Python3_EXECUTABLE

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

Python3_COMPILER

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

Python3_DOTNET_LAUNCHER

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

Python3_LIBRARY

Путь к библиотеке. Он будет использован для вычисления переменных Python3_LIBRARIES, Python3_LIBRARY_DIRS и Python3_RUNTIME_LIBRARY_DIRS.

Python3_INCLUDE_DIR

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

Python3_NumPy_INCLUDE_DIR

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

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

Python3_ARTIFACTS_INTERACTIVE

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

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

Команды

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

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

Если тип библиотеки не указан, используется значение MODULE по умолчанию.

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