Использование F2PY

1. Генерация файла сигнатур

Для сканирования исходных кодов Fortran и генерации файла сигнатур используйте

f2py -h <filename.pyf> <options> <fortran files>   \
  [[ only: <fortran functions>  : ]                \
    [ skip: <fortran functions>  : ]]...           \
  [<fortran files> ...]

Если <filename.pyf> указано как stdout, сигнатуры записываются в стандартный вывод вместо файла.

Среди других параметров (см. ниже), в этом режиме можно использовать следующие:

--overwrite-signature

Перезаписывает существующий файл сигнатур.

2. Создание модуля расширения

Для создания модуля расширения используйте

f2py -m <modulename> <options> <fortran files>   \
  [[ only: <fortran functions>  : ]              \
    [ skip: <fortran functions>  : ]]...          \
  [<fortran files> ...]

Созданный модуль расширения сохраняется как <modulename>module.c в текущем каталоге.

Здесь <fortran files> также может содержать файлы сигнатур. Среди других параметров (см. ниже), в этом режиме можно использовать следующие:

--debug-capi

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

-include'<includefile>'

Добавляет оператор CPP #include в исходный код модуля расширения. <includefile> должно быть указано в одном из следующих форматов

"filename.ext"
<filename.ext>

Оператор включения вставляется непосредственно перед функциями обёртки. Эта функция позволяет использовать произвольные C-функции (определённые в <includefile> ) в сгенерированных F2PY обёртках.

Примечание

Этот параметр устарел. Используйте оператор usercode для непосредственного указания фрагментов кода C в файлах сигнатур.

--[no-]wrap-functions

Создаёт обёртки Fortran-подпрограмм для Fortran-функций. --wrap-functions является значением по умолчанию, поскольку оно обеспечивает максимальную переносимость и независимость от компилятора.

--include-paths "<path1>:<path2>..."

Ищет файлы заголовков в заданных каталогах.

Примечание

Пути должны разделяться корректным разделителем операционной системы pathsep, то есть : на Linux/macOS и ; на Windows. В CMake это соответствует использованию $<SEMICOLON>.

--help-link [<list of resources names>]

Список системных ресурсов, найденных numpy_distutils/system_info.py. Например, попробуйте f2py --help-link lapack_opt.

3. Сборка модуля

Для сборки модуля расширения используйте

f2py -c <options> <fortran files>       \
  [[ only: <fortran functions>  : ]     \
    [ skip: <fortran functions>  : ]]... \
  [ <fortran/c source files> ] [ <.o, .a, .so files> ]

Если <fortran files> содержит файл сигнатур, то генерируется исходный код модуля расширения, все исходные коды Fortran и C компилируются, а затем все объектные файлы и библиотечные файлы связываются с модулем расширения <modulename>.so, который сохраняется в текущем каталоге.

Если <fortran files> не содержит файла сигнатур, то модуль расширения создаётся путём сканирования всех исходных кодов Fortran на наличие сигнатур процедур, прежде чем приступить к сборке модуля расширения.

Среди других параметров (см. ниже) и параметров, описанных для предыдущих режимов, можно использовать следующие.

Общие флаги сборки:

--backend <backend_type>

Указывает бэкенд сборки для процесса компиляции. Поддерживаемые бэкенды — meson и distutils. Если не указано, по умолчанию используется distutils. В Python 3.12 или выше значение по умолчанию — meson.

--f77flags=<string>

Указывает флаги компилятора F77

--f90flags=<string>

Указывает флаги компилятора F90

--debug

Компилировать с отладочной информацией

-l<libname>

Использовать библиотеку <libname> при линковке.

-D<macro>[=<defn=1>]

Определить макрос <macro> как <defn>.

-U<macro>

Определить макрос <macro>

-I<dir>

Добавить каталог <dir> в список каталогов, просматриваемых при поиске файлов заголовков.

-L<dir>

Добавить каталог <dir> в список каталогов для поиска -l.

Флаги, специфичные для meson:

--dep <dependency> только meson

Указывает зависимость meson для модуля. Это может быть передано несколько раз для нескольких зависимостей. Зависимости хранятся в списке для дальнейшей обработки. Пример: --dep lapack --dep scalapack Это определит «lapack» и «scalapack» как зависимости и удалит их из argv, оставив в списке зависимостей [«lapack», «scalapack»].

Старые флаги distutils:

--help-fcompiler без meson

Список доступных компиляторов Fortran.

--fcompiler=<Vendor> без meson

Указывает тип компилятора Fortran по поставщику.

--f77exec=<path> без meson

Укажите путь к компилятору F77

--f90exec=<path> без meson

Укажите путь к компилятору F90

--opt=<string> без meson

Укажите флаги оптимизации

--arch=<string> без meson

Укажите архитектурно-зависимые флаги оптимизации

--noopt без meson

Компилировать без флагов оптимизации

--noarch без meson

Компилировать без архитектурно-зависимых флагов оптимизации

link-<resource> без meson

Связать модуль расширения с <ресурс>, как определено numpy_distutils/system_info.py. Например, для связи с оптимизированными библиотеками LAPACK (vecLib на macOS, ATLAS в других случаях), используйте --link-lapack_opt. Также см. переключатель --help-link.

f2py -c -m fib1 fib1.f

f2py -m fib1 fib1.f -h fib1.pyf
f2py -c fib1.pyf fib1.f

При сборке модуля расширения для не-gcc компиляторов Fortran может потребоваться комбинация следующих макросов:

-DPREPEND_FORTRAN
-DNO_APPEND_FORTRAN
-DUPPERCASE_FORTRAN

Для тестирования производительности интерфейсов, сгенерированных F2PY, используйте -DF2PY_REPORT_ATEXIT. Тогда при завершении работы Python будет напечатан отчёт с различными временными метками. Эта функция может не работать на всех платформах, и в настоящее время поддерживается только Linux.

Для проверки того, копирует ли сгенерированный F2PY интерфейс аргументы массивов, используйте -DF2PY_REPORT_ON_ARRAY_COPY=<int>. Когда размер аргумента массива превышает <int>, сообщение о копировании отправляется в stderr.

Другие параметры

-m <modulename>

Имя модуля расширения. По умолчанию untitled.

--[no-]lower

Преобразовывать [не преобразовывать] регистр символов в <fortran files>. По умолчанию предполагается --lower с переключателем -h, и --no-lower без переключателя -h.

-include<header>

Записывает дополнительные заголовки в C-обёртку, может передаваться несколько раз, каждый раз генерирует #include <header>. Обратите внимание, что это предназначено для передачи в одинарных кавычках без пробелов, например '-include<stdbool.h>'

--build-dir <dirname>

Все созданные F2PY файлы создаются в <dirname>. По умолчанию tempfile.mkdtemp().

--f2cmap <filename>

Загрузить спецификации Fortran-to-C KIND из указанного файла.

--quiet

Работать тихо.

--verbose

Работать с повышенной подробностью.

--skip-empty-wrappers

Не генерировать файлы обёртки, если это не требуется входными данными. Это флаг обратной совместимости для восстановления поведения до 1.22.4.

-v

Вывести версию F2PY и выйти.

Выполните f2py без каких-либо параметров, чтобы получить актуальный список доступных параметров.