F2PY 测试套件#

F2PY 的测试套件位于 numpy/f2py/tests 目录中。其目的是确保 Fortran 语言特性被正确地转换为 Python。例如,用户可以在 Fortran 中指定数组的起始和结束索引。此行为被转换为生成的 CPython 库,其中数组严格从索引 0 开始。

测试套件的目录如下所示

./tests/
├── __init__.py
├── src
│   ├── abstract_interface
│   ├── array_from_pyobj
│   ├── // ... several test folders
│   └── string
├── test_abstract_interface.py
├── test_array_from_pyobj.py
├── // ... several test files
├── test_symbolic.py
└── util.py

test_ 开头的文件包含对 f2py 各个方面的测试,从解析 Fortran 文件到检查模块的文档。 src 目录包含我们进行测试的 Fortran 源文件。 util.py 包含用于在测试期间使用临时位置构建和导入 Fortran 模块的实用程序函数。

添加测试#

F2PY 的当前测试套件早于 pytest,因此不使用 fixture。相反,测试文件包含继承自 util.py 中的 F2PyTest 类的测试类。

 1
 2    # Initialize the MesonBackend
 3    backend = SimplifiedMesonBackend(
 4        modulename=module_name,
 5        sources=source_files,
 6        extra_objects=kwargs.get("extra_objects", []),
 7        build_dir=build_dir,
 8        include_dirs=kwargs.get("include_dirs", []),
 9        library_dirs=kwargs.get("library_dirs", []),
10        libraries=kwargs.get("libraries", []),

此类包含许多用于解析和编译测试源文件的辅助函数。其子类可以覆盖其 sources 数据成员以提供其自己的源文件。此超类将在对象创建时编译添加的源文件,并且其函数将附加到 self.module 数据成员。因此,子类将能够通过调用 self.module.[fortran_function_name] 来访问源文件中指定的 Fortran 函数。

版本 v2.0.0b1 中的新功能。

如果主机上不存在 Fortran 编译器,则每个 f2py 测试都应在没有失败的情况下运行。为了促进这一点,使用了 CompilerChecker,它本质上提供了一组依赖于 meson 的实用程序,即 has_{c,f77,f90,fortran}_compiler()

对于 test_f2py2e 中的 CLI 测试,预计会调用 meson 或以其他方式依赖于编译器的标志需要调用 compiler_check_f2pycli() 而不是 f2pycli()

示例#

考虑以下子例程,它们包含在一个名为 add-test.f 的文件中

        subroutine addb(k)
          real(8), intent(inout) :: k(:)
          k=k+1
        endsubroutine

        subroutine addc(w,k)
          real(8), intent(in) :: w(:)
          real(8), intent(out) :: k(size(w))
          k=w+1
        endsubroutine

第一个例程 addb 只是获取一个数组并将它的元素增加 1。第二个子例程 addc 为一个新数组 k 赋值,其元素比输入数组 w 的元素大 1。

可以如下实现测试

class TestAdd(util.F2PyTest):
    sources = [util.getpath("add-test.f")]

    def test_module(self):
        k = np.array([1, 2, 3], dtype=np.float64)
        w = np.array([1, 2, 3], dtype=np.float64)
        self.module.addb(k)
        assert np.allclose(k, w + 1)
        self.module.addc([w, k])
        assert np.allclose(k, w + 1)

我们覆盖 sources 数据成员以提供源文件。当创建类对象时,源文件会被编译,并且子例程会被附加到模块数据成员。 test_module 函数调用子例程并测试其结果。