高级 F2PY 用例#

将用户定义的函数添加到 F2PY 生成的模块#

usercode用户定义的 Python C/API 函数可以使用和语句在签名文件内定义pymethoddef（它们必须在块内使用）。例如下面的签名文件python modulespam.pyf

!    -*- f90 -*-
python module spam
    usercode '''
  static char doc_spam_system[] = "Execute a shell command.";
  static PyObject *spam_system(PyObject *self, PyObject *args)
  {
    char *command;
    int sts;

    if (!PyArg_ParseTuple(args, "s", &command))
        return NULL;
    sts = system(command);
    return Py_BuildValue("i", sts);
  }
    '''
    pymethoddef '''
    {"system",  spam_system, METH_VARARGS, doc_spam_system},
    '''
end python module spam

包装 C 库函数system()：

f2py -c spam.pyf

在 Python 中，这可以用作：

>>> import spam
>>> status = spam.system('whoami')
pearu
>>> status = spam.system('blah')
sh: line 1: blah: command not found

添加用户定义的变量#

以下示例说明如何通过修改 F2PY 生成模块的字典来将用户定义变量添加到 F2PY 生成的扩展模块。考虑以下签名文件（用编译）：f2py -c var.pyf

!    -*- f90 -*-
python module var
  usercode '''
    int BAR = 5;
  '''
  interface
    usercode '''
      PyDict_SetItemString(d,"BAR",PyInt_FromLong(BAR));
    '''
  end interface
end python module

请注意，第二条usercode语句必须在块内定义interface，并且模块字典可通过变量使用d（请参阅varmodule.cgenerated by了解更多详细信息）。f2py var.pyf

Python 中的用法：

>>> import var
>>> var.BAR
5

处理 KIND 说明符#

目前，F2PY 只能处理其中是数字整数的声明（例如 1、2、4、…），但不能处理函数调用或任何其他表达式。 F2PY 需要知道相应的 C 类型是什么，而通用的解决方案则太复杂而难以实现。<type spec>(kind=<kindselector>)<kindselector>KIND(..)

然而，F2PY 提供了一个钩子来克服这个困难，即用户可以定义自己的 <Fortran type> 到 <C type> 映射。例如，如果 Fortran 90 代码包含：

REAL(kind=KIND(0.0D0)) ...

然后创建一个包含Python字典的映射文件：

{'real': {'KIND(0.0D0)': 'double'}}

例如。

使用--f2cmap命令行选项将文件名传递给 F2PY。默认情况下，F2PY 假定文件名位于.f2py_f2cmap当前工作目录中。

更一般地说，f2cmap 文件必须包含一个包含以下项目的字典：

<Fortran typespec> : {<selector_expr>:<C type>}

定义 Fortran 类型之间的映射：

<Fortran typespec>([kind=]<selector_expr>)

以及相应的<C类型>。 <C 类型> 可以是以下之一：

double
float
long_double
char
signed_char
unsigned_char
short
unsigned_short
int
long
long_long
unsigned
complex_float
complex_double
complex_long_double
string

例如，对于func1.f包含以下内容的 Fortran 文件：

      subroutine func1(n, x, res)
        use, intrinsic :: iso_fortran_env, only: int64, real64
        implicit none
        integer(int64), intent(in) :: n
        real(real64), intent(in) :: x(n)
        real(real64), intent(out) :: res
Cf2py   intent(hide) :: n
        res = sum(x)
      end

为了转换int64为real64有效的C数据类型，.f2py_f2cmap可以在当前目录中创建包含以下内容的文件：

dict(real=dict(real64='double'), integer=dict(int64='long long'))

并像往常一样创建模块。 F2PY 检查.f2py_f2cmap当前目录中是否存在文件，并使用它来将说明KIND符映射到C数据类型。

f2py -c func1.f -m func1

或者，映射文件可以使用任何其他名称保存，例如 mapfile.txt，并且可以使用该选项将此信息传递给 F2PY --f2cmap。

f2py -c func1.f -m func1 --f2cmap mapfile.txt

有关更多信息，请参阅 F2Py 源代码numpy/f2py/capi_maps.py。

字符串#

假定长度字符串#

在 Fortran 中，假定长度的字符串参数被声明为 character*(*)or character(len=*)，也就是说，此类参数的长度由运行时的实际字符串参数决定。对于intent(in)参数来说，长度信息的缺乏不会给 f2py 构造函数包装函数带来任何问题。然而，对于intent(out)参数来说，缺乏长度信息对于 f2py 生成的包装器来说是有问题的，因为没有可用于为此类参数创建内存缓冲区的大小信息，并且 F2PY 假定长度为 0。取决于如何指定假定长度字符串的长度，有一些方法可以解决此问题，如下例所示。

如果输出参数的长度character*(*)由其他输入参数的状态确定，则可以在签名文件或 f2py 注释中通过为相应参数添加额外声明来建立所需的连接，该声明指定字符选择器部分的长度。例如，考虑一个 Fortran 文件asterisk1.f90：

subroutine foo1(s)
  character*(*), intent(out) :: s
  !f2py character(f2py_len=12) s
  s = "123456789A12"
end subroutine foo1

使用和然后在 Python 中编译它：f2py -c asterisk1.f90 -m asterisk1

>>> import asterisk1
>>> asterisk1.foo1()
b'123456789A12'

请注意，额外的声明仅由 f2py 解释，并且在规范中可以使用 C 表达式作为长度值。character(f2py_len=12) sf2py_len=

在以下示例中：

subroutine foo2(s, n)
  character(len=*), intent(out) :: s
  integer, intent(in) :: n
  !f2py character(f2py_len=n), depend(n) :: s
  s = "123456789A123456789B"(1:n)
end subroutine foo2

n在 Python 中，使用 F2PY 包装后，输出假定长度字符串的长度取决于输入参数：

>>> import asterisk
>>> asterisk.foo2(2)
b'12'
>>> asterisk.foo2(12)
b'123456789A12'
>>> 