summaryrefslogtreecommitdiff
path: root/doc/source/f2py
diff options
context:
space:
mode:
authorRohit Goswami <rog32@hi.is>2021-12-04 13:13:27 +0000
committerRohit Goswami <rog32@hi.is>2021-12-04 13:13:27 +0000
commite58d35d2f54240a59b6df9665bb338b9d72eaef6 (patch)
treeea71973340a4578ca3aef0e9285bfbd98ada9308 /doc/source/f2py
parenta81535a364ca2d5aa277977e53c4e2302cae8ea2 (diff)
downloadnumpy-e58d35d2f54240a59b6df9665bb338b9d72eaef6.tar.gz
DOC: Add more details on F2PY output conditions
Diffstat (limited to 'doc/source/f2py')
-rw-r--r--doc/source/f2py/buildtools/index.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/source/f2py/buildtools/index.rst b/doc/source/f2py/buildtools/index.rst
index aa41fd37f..e7492f191 100644
--- a/doc/source/f2py/buildtools/index.rst
+++ b/doc/source/f2py/buildtools/index.rst
@@ -27,6 +27,7 @@ Building an extension module which includes Python and Fortran consists of:
+ A ``C`` wrapper file is always created
+ Code with modules require an additional ``.f90`` wrapper
+ + Code with functions generate an additional ``.f`` wrapper
- ``fortranobject.{c,h}``
@@ -46,7 +47,7 @@ Fortran 77 programs
- Generates
+ ``blahmodule.c``
- + ``f2pywrappers.f``
+ + ``blah-f2pywrappers.f``
When no ``COMMON`` blocks are present only a ``C`` wrapper file is generated.
Wrappers are also generated to rewrite assumed shape arrays as automatic
@@ -57,10 +58,12 @@ Fortran 90 programs
- Generates:
+ ``blahmodule.c``
+ + ``blah-f2pywrappers.f``
+ ``blah-f2pywrappers2.f90``
- The secondary wrapper is used to handle code which is subdivided into
- modules. It rewrites assumed shape arrays as automatic arrays.
+ The ``f90`` wrapper is used to handle code which is subdivided into
+ modules. The ``f`` wrapper makes ``subroutines`` for ``functions``. It
+ rewrites assumed shape arrays as automatic arrays.
Signature files
- Input file ``blah.pyf``
@@ -68,7 +71,7 @@ Signature files
+ ``blahmodule.c``
+ ``blah-f2pywrappers2.f90`` (occasionally)
- + ``f2pywrappers.f`` (occasionally)
+ + ``blah-f2pywrappers.f`` (occasionally)
Signature files ``.pyf`` do not signal their language standard via the file
extension, they may generate the F90 and F77 specific wrappers depending on