Skip to content

build-and-import-python-api.md

Latest commit

 

History

History
55 lines (43 loc) · 1.67 KB

build-and-import-python-api.md

File metadata and controls

55 lines (43 loc) · 1.67 KB
Raw
title Build And Import With The Python API
audience users, developers
prerequisites basic wrapper tutorial, supported compiler toolchain
related ../../reference/python-api.md
status maintained
publication draft

Build And Import With The Python API

Use this recipe when a Python script needs to build a wrapper and load the generated extension directly.

build_fortran_extension returns a result object with the module name, shared library path, generated source paths, and other build artifacts. Call its import_module() method when the script should load the built extension.

from pathlib import Path
from tempfile import TemporaryDirectory

import numpy as np

from prik import build_fortran_extension

source = Path("tests/fortran/building_shared_library/end_to_end/fixtures/native/fruntime_abi_f90.f90")
with TemporaryDirectory() as output_dir:
    build = build_fortran_extension(source, output_dir=output_dir)
    module = build.import_module()
    native_module = module.fruntime_abi_f90

    print(build.module_name)
    print(native_module.scale(np.float64(3.0), np.float64(2.5)))

Expected output:

fruntime_abi_f90
7.5

Notes

  • import_module() avoids editing sys.path and registers the extension under build.module_name in the normal Python module cache.
  • The shared-library file must exist. Direct builds can import immediately; Makefile and source-only results can import after their extension has been built.
  • TemporaryDirectory keeps documentation and tests from leaving build artifacts in the checkout.
  • Use the returned artifact paths when debugging generated code.