Spec-Zone.ru › CMake 3.23

FindPython2

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

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

Новое в версии 3.19: При запросе версии её можно указать как простое значение или диапазон. Для подробного описания использования и возможностей диапазона версий обратитесь к команде find_package().

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

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

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

    • Development.Module: поиск артефактов для разработки модулей Python 2.
    • Development.Embed: поиск артефактов для разработки встраивания Python 2.
  • NumPy: поиск каталогов заголовочных файлов NumPy.

Новое в версии 3.14: Добавлен компонент NumPy.

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

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

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

find_package (Python2 COMPONENTS Interpreter Development)

Этот модуль ищет только версию 2 Python. Этот модуль можно использовать совместно с модулем FindPython3 для использования обеих версий Python.

Модуль FindPython можно использовать, если версия Python не имеет значения.

Примечание

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

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

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

Изменено в версии 3.14: Импортированные цели создаются только тогда, когда CMAKE_ROLE имеет значение PROJECT.

Python2::Interpreter

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

Python2::Compiler

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

Python2::Module

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

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

Python2::Python

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

Python2::NumPy

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

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

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

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

Python2_FOUND

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

Python2_Interpreter_FOUND

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

Python2_EXECUTABLE

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

Python2_INTERPRETER_ID
Короткая строка, уникальная для интерпретатора. Возможные значения:
  • Python
  • ActivePython
  • Anaconda
  • Canopy
  • IronPython
  • PyPy
Python2_STDLIB

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

Информация, возвращаемая distutils.sysconfig.get_python_lib(plat_specific=False,standard_lib=True) или sysconfig.get_path('stdlib').

Python2_STDARCH

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

Информация, возвращаемая distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=True) или sysconfig.get_path('platstdlib').

Python2_SITELIB

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

Информация, возвращаемая distutils.sysconfig.get_python_lib(plat_specific=False,standard_lib=False) или sysconfig.get_path('purelib').

Python2_SITEARCH

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

Информация, возвращаемая distutils.sysconfig.get_python_lib(plat_specific=True,standard_lib=False) или sysconfig.get_path('platlib').

Python2_Compiler_FOUND

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

Python2_COMPILER

Путь к компилятору Python 2. Предлагается только IronPython.

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

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

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

Python2_Development_FOUND

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

Python2_Development.Module_FOUND

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

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

Python2_Development.Embed_FOUND

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

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

Python2_INCLUDE_DIRS

Каталоги заголовочных файлов Python 2.

Python2_LINK_OPTIONS

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

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

Python2_LIBRARIES

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

Python2_LIBRARY_DIRS

Каталоги библиотек Python 2.

Python2_RUNTIME_LIBRARY_DIRS

Каталоги библиотек Python 2 runtime.

Python2_VERSION

Версия Python 2.

Python2_VERSION_MAJOR

Основная версия Python 2.

Python2_VERSION_MINOR

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

Python2_VERSION_PATCH

Вспомогательная версия Python 2.

Python2_PyPy_VERSION

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

Версия PyPy Python 2.

Python2_NumPy_FOUND

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

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

Python2_NumPy_INCLUDE_DIRS

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

Каталоги заголовочных файлов NumPy.

Python2_NumPy_VERSION

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

Версия NumPy.

Рекомендации

Python2_ROOT_DIR

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

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

Примечание

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

Python2_FIND_STRATEGY

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

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

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

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

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

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

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

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

Примечание

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

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

Python2_FIND_VIRTUALENV

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

Эта переменная определяет обработку виртуальных сред, управляемых virtualenv или conda. Она имеет смысл только при активной виртуальной среде (т.е. когда был выполнен скрипт activate). В этом случае она имеет приоритет над переменными Python2_FIND_REGISTRY и CMAKE_FIND_FRAMEWORK. Переменная Python2_FIND_VIRTUALENV может быть установлена в одно из следующих значений:

  • FIRST: Виртуальная среда используется перед любыми другими стандартными путями для поиска интерпретатора. Это значение по умолчанию.
  • ONLY: Только виртуальная среда используется для поиска интерпретатора.
  • STANDARD: Виртуальная среда не используется для поиска интерпретатора, но переменная среды PATH всегда учитывается. В этом случае переменная Python2_FIND_REGISTRY (Windows) или CMAKE_FIND_FRAMEWORK (macOS) может быть установлена со значением LAST или NEVER для предпочтительного использования интерпретатора из виртуальной среды.

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

Примечание

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

Python2_FIND_IMPLEMENTATIONS

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

Эта переменная определяет упорядоченный список различных реализаций, которые будут проверяться. Переменная Python2_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, может быть выбран, так как, например, с Python2_FIND_STRATEGY=LOCATION, каждое место будет сначала проверяться на IronPython, а затем на CPython.

Примечание

Когда IronPython указан, на платформах, отличных от Windows, ожидается, что интерпретатор .Net (т.е. команда mono ) будет доступен через переменную PATH.

Python2_FIND_UNVERSIONED_NAMES

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

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

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

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

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

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

Python2_EXECUTABLE

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

Python2_COMPILER

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

Python2_DOTNET_LAUNCHER

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

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

Python2_LIBRARY

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

Python2_INCLUDE_DIR

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

Python2_NumPy_INCLUDE_DIR

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

Примечание

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

Примечание

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

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

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

Python2_ARTIFACTS_INTERACTIVE

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

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

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

Команды

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

Python2_add_library (<name> [STATIC | SHARED | MODULE]
                     <source1> [<source2> ...])

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

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

Spec-Zone.ru

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