o
    ʩZhOc                     @   s   d dl Z d dlZd dlZd dlZd dlZd dlmZ d dlmZ d dl	Z	d dl
Z
ddlmZ d dlmZ eddZdd
dZe
jdddd Ze
jdddd Ze
jdddd Ze
jdddd Ze
jdddd Ze
jdddd Zdd Zdd Zdd Zd d! Zd"d# Zd$d% Ze
jj e	! d&kpej"d'kd(d)d*d+ Z#e
jj e	! d&kpej"d'kd(d)d,d- Z$e
jj%d.d/ Z&d0d1 Z'd2d3 Z(d4d5 Z)d6d7 Z*d8d9 Z+d:d; Z,d<d= Z-d>d? Z.d@dA Z/dBdC Z0dDdE Z1dFdG Z2dHdI Z3dJdK Z4e
jj%dLd)dMdN Z5dOdP Z6dQdR Z7dSdT Z8dUdV Z9dWdX Z:dYdZ Z;d[d\ Z<d]d^ Z=d_d` Z>e
jj%dLd)dadb Z?dcdd Z@dedf ZAdgdh ZBdidj ZCdkdl ZDdmdn ZEdodp ZFdqdr ZGdsdt ZHdudv ZIdwdx ZJdydz ZKd{d| ZLd}d~ ZMdd ZNdd ZOdd ZPdd ZQdS )    N)Path)
namedtuple   )util)mainPPathsz(finp, f90inp, pyf, wrap77, wrap90, cmodfuntitledc              
   C   sR   t | }t|d|d|d|| d|| d|| ddS )ax  Takes in a temporary file for testing and returns the expected output and input paths

    Here expected output is essentially one of any of the possible generated
    files.

    ..note::

         Since this does not actually run f2py, none of these are guaranteed to
         exist, and module names are typically incorrect

    Parameters
    ----------
    fname_inp : str
                The input filename
    mname : str, optional
                The name of the module, untitled by default

    Returns
    -------
    genp : NamedTuple PPaths
            The possible paths which are generated, not all of which exist
    z.fz.f90.pyfz-f2pywrappers.fz-f2pywrappers2.f90module.c)finpf90inppyfwrap77wrap90cmodf)r   r   with_suffix	with_name)Z	fname_inpmnamebpath r   S/var/www/html/lang_env/lib/python3.10/site-packages/numpy/f2py/tests/test_f2py2e.pyget_io_paths   s   r   session)scopec                 C   2   t dddd }|  d }|j|dd |S )'Generates a single f90 file for testingtestssrcclizhiworld.f90z	hello.f90asciiencodingr   Zgetpath	read_textZgetbasetemp
write_texttmpdir_factoryfdatfnr   r   r   hello_world_f909      r)   c                 C   2   t dddd }|  d }|j|dd |S )z(F90 file for testing warnings in gh23598r   r   Zcrackfortranzgh23598Warn.f90r   r    r"   r%   r   r   r   gh23598_warnB   r*   r,   c                 C   r+   )z8F90 file for testing disallowed CLI arguments in ghff819r   r   r   zgh_22819.pyfr   r    r"   r%   r   r   r   gh22819_cliK   r*   r-   c                 C   r   )'Generates a single f77 file for testingr   r   r   zhi77.fzhello.fr   r    r"   r%   r   r   r   hello_world_f77T   r*   r/   c                 C   r   )r.   r   r   Zreturn_realzfoo77.fzfoo.fr   r    r"   r%   r   r   r   retreal_f77]   r*   r0   c                 C   s`   t dddd }t dddd }|  d }|  d }|j|dd	 |j|dd	 |S )
r   r   r   f2cmapzisoFortranEnvMap.f90z.f2py_f2cmapz
f2cmap.f90Zmapfiler   r    r"   )r&   r'   r1   r(   Zfmapr   r   r   
f2cmap_f90e   s   r2   c                 C   s   t |}|tdd|   t|j0 t  dd |jdD }d|vs+J d|vs1J d|v s7J d	|v s=J 	 W d   dS 1 sIw   Y  dS )zCheck that module names are handled correctly
    gh-22819
    Essentially, the -m name cannot be used to import the module, so the module
    named in the .pyf needs to be used instead

    CLI :: -m and a .pyf file
    argvf2py -m blah c                 S   s   g | ]	}|  r|jqS r   )is_filename).0itemr   r   r   
<listcomp>}   s    z$test_gh22819_cli.<locals>.<listcomp>*zblahmodule.czblah-f2pywrappers.fztest_22819-f2pywrappers.fztest_22819module.czIgnoring blahN)	r   setattrsyssplitr   	switchdirparentf2pyclirglob)capfdr-   monkeypatchipathZ	gen_pathsr   r   r   test_gh22819_cliq   s   "rE   c              	   C   s   t |}|tdd| d  t|j+ tjt	dd t
  W d   n1 s-w   Y  W d   dS W d   dS 1 sEw   Y  dS )zBOnly one .pyf file allowed
    gh-22819
    CLI :: .pyf files
    r3   r4   z
 hello.pyfzOnly one .pyf file per call)matchN)r   r;   r<   r=   r   r>   r?   pytestraises
ValueErrorr@   )rB   r-   rC   rD   r   r   r   test_gh22819_many_pyf   s   "rJ   c                 C   sz   t |dd}|j}|tdd| d  t|j t  |j	
 }d|vs+J W d    d S 1 s6w   Y  d S )Ntestr   r3   f2py z -m testzintproductf2pywrap, intpr)r   r   r;   r<   r=   r   r>   r?   r@   r   r#   )rB   r,   rC   foutlrD   wrapperr   r   r   test_gh23598_warn   s   
"rP   c                 C   s   t |}t |jd }|tdd| d|   t|j! t  | 	 \}}d|v s0J t | 
 s9J W d   dS 1 sDw   Y  dS )zIEnsures that a signature file is generated via the CLI
    CLI :: -h
    r	   r3   zf2py -h  Saving signatures to fileN)r   stemr;   r<   r=   r   r>   r?   r@   
readouterrexists)rB   r)   rC   rD   Zopathout_r   r   r   test_gen_pyf   s   "rX   c                 C   s|   t |}|tdd|   t|j t  |  \}}d|v s&J d|v s,J W d   dS 1 s7w   Y  dS )zHEnsures that a signature file can be dumped to stdout
    CLI :: -h
    r3   zf2py -h stdout rR   zfunction hi() ! in N	r   r;   r<   r=   r   r>   r?   r@   rT   rB   r)   rC   rD   rV   rW   r   r   r   test_gen_pyf_stdout   s   "r[   c              	   C   s   t |}|tdd|   t|j> t djddd t	t
 t  |  \}}d|v s5J W d   n1 s?w   Y  W d   dS W d   dS 1 sWw   Y  dS )	zjEnsures that the CLI refuses to overwrite signature files
    CLI :: -h without --overwrite-signature
    r3   f2py -h faker.pyf 	faker.pyf	Fake newsr   r    z&Use --overwrite-signature to overwriteN)r   r;   r<   r=   r   r>   r?   r$   rG   rH   
SystemExitr@   rT   )rB   r)   rC   rD   rW   errr   r   r   test_gen_pyf_no_overwrite   s   "ra   Linux)      zCompiler and 3.12 required)reasonc                 C   sp   t |}|tdd|   t|j t  |  \}}d|v s&J W d   dS 1 s1w   Y  dS )z@Check that modules are named correctly

    CLI :: defaults
    r3   zf2py --backend meson -c zuntitledmodule.cNrY   rZ   r   r   r   test_untitled_cli   s   "rf   c              	   C   sN  d}t ||d}|j}|tdd| d|   t|j t  | 	 \}}d|v s0J W d   n1 s:w   Y  |tdd  t|j t  | 	 \}}d	|v s^J W d   n1 shw   Y  d
}|tdd| d| d  t|j t  | 	 \}}d|v sJ W d   dS 1 sw   Y  dS )zqCheck that no distutils imports are performed on 3.12
    CLI :: --fcompiler --help-link --backend distutils
    hirL   r3   rM   z -c --fcompiler=gfortran -m z%--fcompiler cannot be used with mesonNzf2py --help-linkzUse --dep for meson buildsZhi2z -c -m z --backend distutilsz.Cannot use distutils backend with Python>=3.12)
r   r   r;   r<   r=   r   r>   r?   r@   rT   )rB   r)   rC   MNAMErN   rD   rV   rW   r   r   r   !test_no_py312_distutils_fcompiler   s8   
"ri   c                 C   s   t |dd}|j}d}d}|tdd| d|   t|j4 t  | 	 \}}| D ]}	d|	 d	|v s<J q0| D ]}
d
|
 d|v sMJ qAW d   dS 1 sYw   Y  dS )z9Tests that functions can be skipped
    CLI :: skip:
    rK   rL   t0 t4 t8 sd s8 s4td s0r3   rM   z -m test skip: z=buildmodule: Could not found the body of interfaced routine "". Skipping.Constructing wrapper function ""N
r   r   r;   r<   r=   r   r>   r?   r@   rT   )rB   r0   rC   rN   rD   toskip	remainingrV   r`   skeyrkeyr   r   r   test_f2py_skip   s&   

"rt   c                 C   s   t |dd}|j}d}d}|tdd| d|   t|j4 t  | 	 \}}| D ]}	d|	 d	|v s<J q0| D ]}
d
|
 d|v sMJ qAW d   dS 1 sYw   Y  dS )z>Test that functions can be kept by only:
    CLI :: only:
    rK   rL   rj   rk   r3   rM   z -m test only: <buildmodule: Could not find the body of interfaced routine "rl   rm   rn   Nro   )rB   r0   rC   rN   rD   rp   tokeeprV   r`   rr   rs   r   r   r   test_f2py_only  s&   

"rw   c                 C   s   t |dd}|j}d}t|}d}d}	|tdd| d|	 d	| d
|   t|j4 t	  | 
 \}
}| D ]}d| d|v sHJ q<| D ]}d| d|
v sYJ qMW d   dS 1 sew   Y  dS )zfTests that it is possible to return to file processing mode
    CLI :: :
    BUG: numpy-gh #20520
    rK   rL   rj   ztd s0 hiblahr3   rM    -m z only: z : ru   rl   rm   rn   N)r   r   r   r;   r<   r=   r   r>   r?   r@   rT   )rB   r)   r0   rC   rN   rD   rp   Zipath2rv   r   rV   r`   rr   rs   r   r   r   test_file_processing_switch'  s,   

"rz   c                 C   s   d}t ||d}|j}|tdd| d|   t|j t  W d   n1 s.w   Y  t	
|js;J t	
|jsCJ dS )zHChecks the generation of files based on a module name
    CLI :: -m
    rg   rL   r3   rM   ry   N)r   r   r;   r<   r=   r   r>   r?   r@   r   rU   r   r   )rB   r)   rC   rh   rN   rD   r   r   r   test_mod_gen_f77E  s   r{   c              	   C   s   d}t ||d}|j}|tdd| d| d  t|j4 t  t	d
 }| }d|v s6J W d	   n1 s@w   Y  W d	   d	S W d	   d	S 1 sXw   Y  d	S )
zCheck that pyf files are correctly generated with module structure
    CLI :: -m <name> -h pyf_file
    BUG: numpy-gh #20520
    rg   rL   r3   rM   ry   z
 -h hi.pyfzhi.pyfzpython module hiN)r   r   r;   r<   r=   r   r>   r?   r@   r   openread)rB   r/   rC   rh   rN   rD   ZhipyfZpyfdatr   r   r   test_mod_gen_gh25263V  s    "r~   c           	      C   s$  t |dd}|j}td}td}|tdd| d  t|j	# t
  |  \}}||dus9J ||du sBJ W d   n1 sLw   Y  |tdd| d	  t|j	$ t
  |  \}}||du swJ ||dusJ W d   dS 1 sw   Y  dS )
zHLowers cases by flag or when -h is present

    CLI :: --[no-]lower
    rK   rL   zHI\(\)zhi\(\)r3   rM   z -m test --lowerNz -m test --no-lower)r   r   recompiler;   r<   r=   r   r>   r?   r@   rT   search	rB   r/   rC   rN   rD   ZcapshiZcapslorV   rW   r   r   r   test_lower_cmodf  s(   

"r   c           	   	   C   s4  t |dd}|j}td}td}|tdd| d|j d  t	|j
# t  |  \}}||d	us=J ||d	u sFJ W d	   n1 sPw   Y  |tdd| d|j d
  t	|j
$ t  |  \}}||d	u sJ ||d	usJ W d	   d	S 1 sw   Y  d	S )z^Lowers cases in signature files by flag or when -h is present

    CLI :: --[no-]lower -h
    rK   rL   z	Block: HIz	Block: hir3   rM   z -h z -m test --overwrite-signatureNz) -m test --overwrite-signature --no-lower)r   r   r   r   r;   r<   r   r=   r   r>   r?   r@   rT   r   r   r   r   r   test_lower_sig  s6   

"r   c              
   C   s   t |}d}d}|tdd| d| d|   t|j t  |  \}}d| d|v s4J W d	   d	S 1 s?w   Y  d	S )
zNEnsures that the build directory can be specified

    CLI :: --build-dir
    rx   Ztttmpr3   f2py -m rQ   z --build-dir zWrote C/API module "rn   NrY   )rB   r)   rC   rD   r   ZodirrV   rW   r   r   r   test_build_dir  s   "r   c                 C   s   t |}|tdd| d  t|j! t djddd t  | 	 \}}d|v s0J W d	   d	S 1 s;w   Y  d	S )
zXEnsures that the build directory can be specified

    CLI :: --overwrite-signature
    r3   r\   z --overwrite-signaturer]   r^   r   r    rR   N)
r   r;   r<   r=   r   r>   r?   r$   r@   rT   rZ   r   r   r   test_overwrite  s   "r   c              	   C   s   t |}d}|tdd| d| d  t|jA t  |  \}}d|v s,J t | d	 }d|
 v s>J W d	   n1 sHw   Y  W d	   d	S W d	   d	S 1 s`w   Y  d	S )
zJEnsures that TeX documentation is written out

    CLI :: --latex-doc
    rx   r3   r   rQ   z --latex-docDocumentation is saved to file
module.tex\documentclassNr   r;   r<   r=   r   r>   r?   r@   rT   r|   r}   rB   r)   rC   rD   r   rV   rW   Zotexr   r   r   test_latexdoc  s   "r   c              	   C   |   t |}d}|tdd| d| d  t|j t  |  \}}d|vs,J W d   dS 1 s7w   Y  dS )zMEnsures that TeX documentation is written out

    CLI :: --no-latex-doc
    rx   r3   r   rQ   z --no-latex-docr   NrY   rB   r)   rC   rD   r   rV   rW   r   r   r   test_nolatexdoc     "r   c              	   C   s   t |}d}|tdd| d| d  t|jB t  |  \}}d|v s,J t d| d	 }d	|
 vs?J W d
   n1 sIw   Y  W d
   d
S W d
   d
S 1 saw   Y  d
S )zEnsures that truncated documentation is written out

    TODO: Test to ensure this has no effect without --latex-doc
    CLI :: --latex-doc --short-latex
    rx   r3   r   rQ   z --latex-doc --short-latexr   ./r   r   Nr   r   r   r   r   test_shortlatex  s"   "r   c              	   C   s   t |}d}|tdd| d| d  t|jB t  |  \}}d|v s,J t d| d	 }d	|
 v s?J W d
   n1 sIw   Y  W d
   d
S W d
   d
S 1 saw   Y  d
S )zIEnsures that RsT documentation is written out

    CLI :: --rest-doc
    rx   r3   r   rQ   z --rest-doc#ReST Documentation is saved to filer   zmodule.restz.. -*- rest -*-Nr   )rB   r)   rC   rD   r   rV   rW   Zorstr   r   r   test_restdoc  s   "r   c              	   C   r   )zLEnsures that TeX documentation is written out

    CLI :: --no-rest-doc
    rx   r3   r   rQ   z --no-rest-docr   NrY   r   r   r   r   test_norestexdoc  r   r   c              	   C   s   t |}d}|tdd| d| d  t|j6 t  t d| d }d|	 v s3J W d	   n1 s=w   Y  W d	   d	S W d	   d	S 1 sUw   Y  d	S )
zIEnsures that debugging wrappers are written

    CLI :: --debug-capi
    rx   r3   r   rQ   z --debug-capir   r
   z#define DEBUGCFUNCSN
r   r;   r<   r=   r   r>   r?   r@   r|   r}   )rB   r)   rC   rD   r   ocmodr   r   r   test_debugcapi#  s   "r   zConsistently fails on CI.c              	   C   s   t | }d}|tdd| d| d  t|j. t  td}t	j
|ddd	}d
}td}|j|ks;J |j|ksBJ W d   dS 1 sMw   Y  dS )zEEnsures that debugging wrappers work

    CLI :: --debug-capi -c
    rx   r3   r   rQ   z -c --debug-capiz#python3 -c "import blah; blah.hi()"TUTF-8capture_outputr!    Hello World
a   debug-capi:Python C/API function blah.hi()
debug-capi:float hi=:output,hidden,scalar
debug-capi:hi=0
debug-capi:Fortran subroutine `f2pywraphi(&hi)'
debug-capi:hi=0
debug-capi:Building return value.
debug-capi:Python C/API function blah.hi: successful.
debug-capi:Freeing memory.
        N)r   r;   r<   r=   r   r>   r?   r@   shlex
subprocessruntextwrapdedentstdoutstderr)r)   rC   rD   r   cmd_runrouteoutZeerrr   r   r   test_debugcapi_bld3  s   


"r   c              	   C   s   t |}d}|tdd| d|   t|j t  W d   n1 s)w   Y  |  \}}d|v s:J |tdd| d| d  t|j t  |  \}}d|v s`J W d   dS 1 skw   Y  dS )zoEnsures that fortran subroutine wrappers for F77 are included by default

    CLI :: --[no]-wrap-functions
    rx   r3   r   rQ   N Fortran 77 wrappers are saved toz --wrap-functionsrY   r   r   r   r   test_wrapfunc_defQ  s    "r   c              	   C   r   )zeEnsures that fortran subroutine wrappers for F77 can be disabled

    CLI :: --no-wrap-functions
    rx   r3   r   rQ   z --no-wrap-functionsr   NrY   r   r   r   r   test_nowrapfuncj  r   r   c              	   C   s   t |}d}|tdd| d| d  t|j> t  t d| d }|	 }d|v s5J d	|v s;J W d
   n1 sEw   Y  W d
   d
S W d
   d
S 1 s]w   Y  d
S )zcAdd to the include directories

    CLI :: -include
    TODO: Document this in the help string
    rx   r3   r   rQ   z' -include<stdbool.h> -include<stdio.h> r   r
   z#include <stdbool.h>z#include <stdio.h>Nr   )rB   r)   rC   rD   r   r   Zocmrr   r   r   test_inclheaderz  s$   "r   c                   C      dS )z?Add to the include directories

    CLI :: --include-paths
    Nr   r   r   r   r   test_inclpath     r   c                   C   r   )z;Add to the include directories

    CLI :: --help-link
    Nr   r   r   r   r   
test_hlink  r   r   c                 C   s   t |}|tdd| d  t|j0 t  |  \}}d|v s'J d|v s-J d|v s3J d|v s9J d|v s?J W d	   d	S 1 sJw   Y  d	S )
zOCheck that Fortran-to-Python KIND specs can be passed

    CLI :: --f2cmap
    r3   r4   z --f2cmap mapfilez!Reading f2cmap from 'mapfile' ...z&Mapping "real(kind=real32)" to "float"z'Mapping "real(kind=real64)" to "double"z,Mapping "integer(kind=int64)" to "long_long"z0Successfully applied user defined f2cmap changesNrY   )rB   r2   rC   rD   rV   rW   r   r   r   test_f2cmap  s   "r   c                 C   sv   t |}|tdd| d  t|j t  |  \}}t	|dks)J W d   dS 1 s4w   Y  dS )z)Reduce verbosity

    CLI :: --quiet
    r3   r4   z --quietr   N)
r   r;   r<   r=   r   r>   r?   r@   rT   lenrZ   r   r   r   
test_quiet  s   "r   c                 C   sr   t |}|tdd| d  t|j t  |  \}}d|v s'J W d   dS 1 s2w   Y  dS )z-Increase verbosity

    CLI :: --verbose
    r3   r4   z
 --verboseZanalyzelineNrY   rZ   r   r   r   test_verbose  s   "r   c                 C   sn   | tdd  tt t  |  \}}ddl}|j	|
 ks%J W d   dS 1 s0w   Y  dS )z"Ensure version

    CLI :: -v
    r3   zf2py -vr   N)r;   r<   r=   rG   rH   r_   r@   rT   numpy__version__strip)rB   rC   rV   rW   npr   r   r   test_version  s   "r   c                 C   s   t | }|tdd| d  t|j" t  td}t	j
|ddd}d}|j|ks1J W d	   d	S 1 s<w   Y  d	S )
z
    CLI :: -c
    r3   r4   z -cz"python -c "import blah; blah.hi()"Tr   r   r   N)r   r;   r<   r=   r   r>   r?   r@   r   r   r   r   )r)   rC   rD   r   r   r   r   r   r   test_npdistop  s   
"r   c                   C   r   )z
    CLI :: -c --fcompiler
    Nr   r   r   r   r   test_npd_fcompiler     r   c                   C   r   )z
    CLI :: -c --compiler
    Nr   r   r   r   r   test_npd_compiler  r   r   c                   C   r   )z$
    CLI :: -c --help-fcompiler
    Nr   r   r   r   r   test_npd_help_fcompiler  r   r   c                   C   r   )z
    CLI :: -c --f77exec
    Nr   r   r   r   r   test_npd_f77exec  r   r   c                   C   r   )z
    CLI :: -c --f90exec
    Nr   r   r   r   r   test_npd_f90exec  r   r   c                   C   r   )z
    CLI :: -c --f77flags
    Nr   r   r   r   r   test_npd_f77flags  r   r   c                   C   r   )z
    CLI :: -c --f90flags
    Nr   r   r   r   r   test_npd_f90flags#  r   r   c                   C   r   )z
    CLI :: -c --opt
    Nr   r   r   r   r   test_npd_opt+  r   r   c                   C   r   )z
    CLI :: -c --arch
    Nr   r   r   r   r   test_npd_arch3  r   r   c                   C   r   )z
    CLI :: -c --noopt
    Nr   r   r   r   r   test_npd_noopt;  r   r   c                   C   r   )z
    CLI :: -c --noarch
    Nr   r   r   r   r   test_npd_noarchC  r   r   c                   C   r   )z
    CLI :: -c --debug
    Nr   r   r   r   r   test_npd_debugK  r   r   c                   C   r   )z%
    CLI :: -c --link-<resource>
    Nr   r   r   r   r   test_npd_link_autoS  r   r   c                   C   r   )z/
    CLI :: -c -L/path/to/lib/ -l<libname>
    Nr   r   r   r   r   test_npd_lib[  r   r   c                   C   r   )z
    CLI :: -D<define>
    Nr   r   r   r   r   test_npd_definec  r   r   c                   C   r   )z
    CLI :: -U<name>
    Nr   r   r   r   r   test_npd_undefinek  r   r   c                   C   r   )z$
    CLI :: -I/path/to/include/
    Nr   r   r   r   r   test_npd_incls  r   r   c                   C   r   )z8
    CLI :: <filename>.o <filename>.so <filename>.a
    Nr   r   r   r   r   test_npd_linker{  r   r   )r   )Rr   r   r<   r   r   pathlibr   collectionsr   platformrG    r   Znumpy.f2py.f2py2er   r@   r   r   Zfixturer)   r,   r-   r/   r0   r2   rE   rJ   rP   rX   r[   ra   markZskipifsystemversion_inforf   ri   Zxfailrt   rw   rz   r{   r~   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   r   <module>   s   ( 


'











 

'
		
