FindPython3

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

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

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

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

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

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

  Новое в версии 3.26:

  • Development.SABIModule: поиск артефактов для разработки модулей Python 3 с использованием Stable Application Binary Interface. Этот компонент доступен только для версии 3.2 и выше.
• 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::SABIModule

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

Библиотека Python 3 для модуля Python, использующая Stable Application Binary Interface. Цель определена, если найден компонент Development.SABIModule.

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('EXT_SUFFIX'), distutils.sysconfig.get_config_var('SOABI') или python3-config --extension-suffix. Если пакет distutils.sysconfig недоступен, используются sysconfig.get_config_var('EXT_SUFFIX') или sysconfig.get_config_var('SOABI').

Python3_SOSABI

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

Суффикс расширения для модулей, использующих Stable Application Binary Interface.

Информация вычисляется из importlib.machinery.EXTENSION_SUFFIXES, если был указан компонент Interpreter. В противном случае расширение равно abi3, за исключением Windows, MSYS и CYGWIN, для которых оно пустое.

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.SABIModule_FOUND

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

Система имеет артефакты разработки Python 3 для модулей Python, использующие Stable Application Binary Interface.

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_SABI_LIBRARIES

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

Библиотеки Python 3 для Stable Application Binary Interface.

Python3_SABI_LIBRARY_DIRS

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

Директории библиотек Python 3 SABI.

Python3_RUNTIME_SABI_LIBRARY_DIRS

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

Директории библиотек времени выполнения Python 3 SABI.

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

Примечание

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

Python3_FIND_ABI

Введено в версии 3.16.

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

Примечание

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

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

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

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

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

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

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

И для проверки всех возможных ABIs:

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_SABI_LIBRARY

Введено в версии 3.26.

Путь к библиотеке для стабильного приложения Binary Interface. Он будет использоваться для вычисления переменных Python3_SABI_LIBRARIES, Python3_SABI_LIBRARY_DIRS и Python3_RUNTIME_SABI_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 или Python3::SABIModule (когда указан параметр USE_SABI) и учитывает правила именования модулей Python:

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

Если тип библиотеки не указан, предполагается MODULE.