FindPython3

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

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

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

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

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

  • 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 не имеет значения.

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

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

Python3::Interpreter

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

Python3::Compiler

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

Python3::Module

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

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

Python3::Python

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

Python3::NumPy

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

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

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

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

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

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

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

Python3_Development_FOUND

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

Python3_Development.Module_FOUND

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

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

Python3_Development.Embed_FOUND

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

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

Python3_INCLUDE_DIRS

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

Python3_LINK_OPTIONS

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

Параметры линковки 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

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

Версия Python 3 PyPy.

Python3_NumPy_FOUND

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

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

Python3_NumPy_INCLUDE_DIRS

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

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

Python3_NumPy_VERSION

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

Версия NumPy.

Подсказки

Python3_ROOT_DIR

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

Python3_USE_STATIC_LIBS

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

Python3_FIND_ABI

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

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

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

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

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

Python3_FIND_REGISTRY

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

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

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

Python3_FIND_FRAMEWORK

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

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

Примечание

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

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

Python3_FIND_VIRTUALENV

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

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

Новое в версии 3.17: Добавлена поддержка conda сред.

Примечание

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

Python3_FIND_IMPLEMENTATIONS

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

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

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

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

• FIRST: Общие имена проверяются до более специализированных (например, python3.5).
• LAST: Общие имена проверяются после более специализированных. Это значение по умолчанию.
• NEVER: Общие имена не проверяются.

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

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

Python3_EXECUTABLE

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

Python3_COMPILER

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

Python3_DOTNET_LAUNCHER

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

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

Новая версия 3.18.

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

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