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)

Этот модуль ищет только версию 3 Python. Этот модуль может использоваться совместно с модулем 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.

Версия PyPy Python 3.

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, поиск будет осуществляться только общих библиотек.

Примечание

Этот подсказка будет проигнорирована на Windows , так как статические библиотеки недоступны на этой платформе.

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.