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. Для управления одновременными версиями 3 и 2 Python используйте модули FindPython3 и FindPython2, а не этот.

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

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

Python::Interpreter

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

Python::InterpreterDebug

Добавлен в версии 3.30.

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

Python::InterpreterMultiConfig

Добавлен в версии 3.30.

Интерпретатор Python. Будет использована версия интерпретатора релиз или отладка, в зависимости от контекста (платформа, конфигурация). Эта цель определена только если найден компонент 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.

Эта переменная определяет, какие ABI, как определено в 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 не определено, будут просмотрены любые ABI, исключая флаг gil_disabled.

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

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

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

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

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

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.