Spec-Zone.ru › CMake 3.18

FindPython3

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

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

  • Interpreter: поиск интерпретатора Python 3
  • Compiler: поиск компилятора Python 3. Предлагается только для IronPython.
  • Development: поиск артефактов разработки (каталоги заголовков и библиотеки). Этот компонент включает два подкомпонента, которые могут быть указаны независимо:

    • 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 для вас не важна.

Примечание

Если оба компонента Interpreter и Development (или один из его подкомпонентов) указаны, этот модуль ищет только интерпретатор с той же архитектурой платформы, что и заданная конфигурацией CMake. Это ограничение не применяется, если указан только компонент Interpreter.

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

Этот модуль определяет следующие Импортированные цели (когда CMAKE_ROLE равно PROJECT):

Python3::Interpreter

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

Python3::Compiler

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

Python3::Module

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

Python3::Python

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

Python3::NumPy

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

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

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

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

Python3_Development_FOUND

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

Python3_Development.Module_FOUND

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

Python3_Development.Embed_FOUND

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

Python3_INCLUDE_DIRS

Каталоги заголовков 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

Версия PyPy Python 3.

Python3_NumPy_FOUND

Система содержит NumPy.

Python3_NumPy_INCLUDE_DIRS

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

Python3_NumPy_VERSION

Версия NumPy.

Подсказки

Python3_ROOT_DIR

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

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

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

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

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

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

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

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

Примечание

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

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

Python3_FIND_VIRTUALENV

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

Примечание

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

Python3_FIND_IMPLEMENTATIONS

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

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

Python3_COMPILER

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

Python3_DOTNET_LAUNCHER

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

Python3_LIBRARY

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

Python3_INCLUDE_DIR

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

Python3_NumPy_INCLUDE_DIR

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

Примечание

Все пути должны быть абсолютными. Любой артефакт, указанный с относительным путём, будет проигнорирован.

Примечание

Когда артефакт указан, все HINTS будут проигнорированы, и поиск этого артефакта не будет выполняться.

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

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

Python3_ARTIFACTS_INTERACTIVE

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

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

Для библиотечного типа MODULE, если указан параметр WITH_SOABI, суффикс модуля будет включать значение Python3_SOABI, если таковое есть.

© 2000–2020 Kitware, Inc. and Contributors
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.18/module/FindPython3.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API