FindPython

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

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

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

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

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

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

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

  • Development.SABIModule: поиск артефактов для разработки модулей Python, используя Stable Application Binary Interface. Этот компонент доступен только для версии 3.2 и выше.
• NumPy: поиск каталогов заголовков NumPy.

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

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

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

find_package (Python COMPONENTS Interpreter Development)

Этот модуль предпочтительно ищет Python версии 3. Если не найден, ищется версия 2. Для управления одновременными версиями Python 3 и 2 используйте модули FindPython3 и FindPython2, а не этот.

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

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

Python::Interpreter

Интерпретатор Python. Эта цель определена только если найден компонент Interpreter.

Python::InterpreterDebug

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

Отладочный интерпретатор Python. Эта цель определена только если найден компонент Interpreter и определена переменная Python_EXECUTABLE_DEBUG. Цель определена только для платформы Windows.

Python::InterpreterMultiConfig

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

Интерпретатор Python. Используется версия интерпретатора Release или Debug в зависимости от контекста (платформа, конфигурация). Эта цель определена только если найден компонент Interpreter.

Python::Compiler

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

Python::Module

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

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

Python::SABIModule

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

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

Python::Python

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

Python::NumPy

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

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

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

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

Python_FOUND

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

Python_Interpreter_FOUND

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

Python_EXECUTABLE

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

Python_EXECUTABLE_DEBUG

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

Путь к отладочному интерпретатору Python. Определён только на платформе Windows.

Python_INTERPRETER

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

Путь к интерпретатору Python, определённый как generator expression для выбора переменной Python_EXECUTABLE или Python_EXECUTABLE_DEBUG в зависимости от контекста (платформа, конфигурация).

Python_INTERPRETER_ID

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

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

Python_STDLIB

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

Информация, возвращаемая sysconfig.get_path('stdlib').

Python_STDARCH

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

Информация, возвращаемая sysconfig.get_path('platstdlib').

Python_SITELIB

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

Информация, возвращаемая sysconfig.get_path('purelib').

Python_SITEARCH

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

Информация, возвращаемая sysconfig.get_path('platlib').

Python_SOABI

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

Расширение для модулей.

Информация, вычисленная из sysconfig.get_config_var('EXT_SUFFIX') или sysconfig.get_config_var('SOABI') или python3-config --extension-suffix.

Python_SOSABI

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

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

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

Python_Compiler_FOUND

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

Python_COMPILER

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

Python_COMPILER_ID

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

• IronPython

Python_DOTNET_LAUNCHER

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

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

Python_Development_FOUND

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

Python_Development.Module_FOUND

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

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

Python_Development.SABIModule_FOUND

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

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

Python_Development.Embed_FOUND

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

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

Python_INCLUDE_DIRS

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

Python_DEFINITIONS

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

Определения препроцессора Python.

Python_DEBUG_POSTFIX

Суффикс модуля отладки Python. Эта переменная может быть использована для определения свойства целевого объекта DEBUG_POSTFIX.

Python_LINK_OPTIONS

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

Параметры ссылки Python. Некоторые конфигурации требуют определённых параметров ссылки для корректной сборки и выполнения.

Python_LIBRARIES

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

Python_LIBRARY_DIRS

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

Python_RUNTIME_LIBRARY_DIRS

Директории библиотек среды выполнения Python.

Python_SABI_LIBRARIES

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

Библиотеки Python для стабильного интерфейса прикладного двоичного кода.

Python_SABI_LIBRARY_DIRS

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

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

Python_RUNTIME_SABI_LIBRARY_DIRS

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

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

Python_VERSION

Версия Python.

Python_VERSION_MAJOR

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

Python_VERSION_MINOR

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

Python_VERSION_PATCH

Исправительная версия Python.

Python_PyPy_VERSION

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

Версия Python PyPy.

Python_NumPy_FOUND

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

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

Python_NumPy_INCLUDE_DIRS

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

Директории заголовочных файлов NumPy.

Python_NumPy_VERSION

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

Версия NumPy.

Подсказки

Python_ROOT_DIR

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

Python_USE_STATIC_LIBS

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

Примечание

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

Python_FIND_ABI

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

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

Примечание

Этот совет будет учтён только при поиске Python версии 3.

Переменная Python_FIND_ABI представляет собой 4-кортеж, в котором в указанном порядке содержатся pydebug (d), pymalloc (m), unicode (u) и gil_disabled (t).

Новое в версии 3.30: Добавлен четвёртый элемент, определяющий флаг gil_disabled (т.е. многопоточный Python), который является необязательным. Если не указано, значение равно OFF.

Каждый элемент может быть установлен в одно из следующих значений:

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

Примечание

Если Python3_FIND_ABI не определён, будут проверены все ABIs, за исключением флага gil_disabled.

На основании этого 4-кортежа будут проверены различные ABIs, начиная с наиболее специализированных и заканчивая наиболее общими. Кроме того, когда ANY указан для pydebug и gil_disabled, debug и free threaded версии будут проверены после non-debug и non-gil-disabled.

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

set (Python_FIND_ABI "ON" "ANY" "ANY" "ON")

Следующие комбинации флагов будут добавлены в имена артефактов в указанном порядке: tdmu, tdm, tdu, и td.

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

set (Python_FIND_ABI "ANY" "ANY" "ANY" "ANY")

Следующие комбинации, в указанном порядке, будут использованы: mu, m, u, <empty>, dmu, dm, du, d, tmu, tm, tu, t, tdmu, tdm, tdu, и td.

Примечание

Этот совет полезен только на POSIX системах, за исключением флага gil_disabled. Таким образом, на Windows системах, когда Python_FIND_ABI определено, Python дистрибутивы с python.org будут найдены только в том случае, если значение для каждого флага равно OFF или ANY, за исключением четвёртого (gil_disabled).

Python_FIND_STRATEGY

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

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

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

См. также Python_FIND_UNVERSIONED_NAMES.

Python_FIND_REGISTRY

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

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

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

Python_FIND_FRAMEWORK

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

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

Примечание

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

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

Python_FIND_VIRTUALENV

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

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

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

Примечание

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

Python_FIND_IMPLEMENTATIONS

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

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

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

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

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

См. также Python_FIND_STRATEGY.

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

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

Python_EXECUTABLE

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

Python_COMPILER

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

Python_DOTNET_LAUNCHER

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

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

Python_LIBRARY

Путь к библиотеке. Будет использоваться для вычисления переменных Python_LIBRARIES, Python_LIBRARY_DIRS и Python_RUNTIME_LIBRARY_DIRS.

Python_SABI_LIBRARY

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

Путь к библиотеке для стабильного интерфейса прикладного двоичного кода. Будет использоваться для вычисления переменных Python_SABI_LIBRARIES, Python_SABI_LIBRARY_DIRS и Python_RUNTIME_SABI_LIBRARY_DIRS.

Python_INCLUDE_DIR

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

Python_NumPy_INCLUDE_DIR

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

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

Python_ARTIFACTS_INTERACTIVE

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

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

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

Команды

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

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

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