3 sdE@s*dZddlZddlZddlmZmZddlmZddlZddl Z ddl Z ddl Z ddl m Z mZejdkZejZeedZdZd+d d Zd,d dZd-ddZedfddZdedfddZddZddZd.ddZd e_ddZd/ddZ d0d d!Z!d"d#Z"d1d%d&Z#d e#_d2d'd(Z$d e$_d)d*Z%dS)3a` Test package information in various install settings The routines here install the package from source directories, zips or eggs, and check these installations by running tests, checking version information, looking for files that were not copied over. The typical use for this module is as a Makefile target. For example, here are the Makefile targets from nibabel:: # Check for files not installed check-files: $(PYTHON) -c 'from nisext.testers import check_files; check_files("nibabel")' # Print out info for possible install methods check-version-info: $(PYTHON) -c 'from nisext.testers import info_from_here; info_from_here("nibabel")' # Run tests from installed code installed-tests: $(PYTHON) -c 'from nisext.testers import tests_installed; tests_installed("nibabel")' # Run tests from installed code sdist-tests: $(PYTHON) -c 'from nisext.testers import sdist_tests; sdist_tests("nibabel")' # Run tests from binary egg bdist-egg-tests: $(PYTHON) -c 'from nisext.testers import bdist_egg_tests; bdist_egg_tests("nibabel")' N)joinabspath)glob)PopenPIPEntputenvZpylibFTcCst|tttd}|j\}}|j}|dkr>|jt|d|dkrVt|d||j}|rl|jd}|st|S|j}|r|jd}||fS)a Run command `cmd`, return stdout, or stdout, stderr if `ret_err` Roughly equivalent to ``check_output`` in Python 2.7 Parameters ---------- cmd : str command to execute ret_err : bool, optional If True, return stderr in addition to stdout. If False, just return stdout as_str : bool, optional Whether to decode outputs to unicode string on exit. Returns ------- out : str or tuple If `ret_err` is False, return stripped string containing stdout from `cmd`. If `ret_err` is True, return tuple of (stdout, stderr) where ``stdout`` is the stripped stdout, and ``stderr`` is the stripped stderr. Raises ------ RuntimeError if command returns non-zero exit code. )stdoutstderrshellNz process did not terminaterz process returned code %dzlatin-1) rr NEEDS_SHELL communicate returncode terminate RuntimeErrorstripdecode)cmdret_errZas_strprocouterrretcoder1/tmp/pip-build-7vycvbft/nibabel/nisext/testers.py back_tick1s"    rc Cs|dkrd}ntstddjft}|r:d|d}nd}tj}tj}zJtj|t dd} | j d jftWdQRXt t d d d } Wdtj|t j|X| S) a Run command in own process in anonymous path Parameters ---------- mod_name : str Name of module to import - e.g. 'nibabel' pkg_path : str directory containing `mod_name` package. Typically that will be the directory containing the e.g. 'nibabel' directory. cmd : str Python command to execute script_dir : None or str, optional script directory to prepend to PATH print_location : bool, optional Whether to print the location of the imported `mod_name` Returns ------- stdout : str stdout as str stderr : str stderr as str Nz#We cannot set environment variablesa os.environ['PATH'] = r'"{script_dir}"' + os.path.pathsep + os.environ['PATH'] PYTHONPATH = os.environ.get('PYTHONPATH') if PYTHONPATH is None: os.environ['PYTHONPATH'] = r'"{pkg_path}"' else: os.environ['PYTHONPATH'] = r'"{pkg_path}"' + os.path.pathsep + PYTHONPATH zprint(z .__file__);z script.pywtzc import os import sys sys.path.insert(0, r"{pkg_path}") {paths_add} import {mod_name} {p_loc} {cmd}z script.pyT)r) HAVE_PUTENVrformatlocalsosgetcwdtempfilemkdtempchdiropenwriterPYTHONshutilrmtree) mod_nameZpkg_pathrZ script_dirZprint_locationZ paths_addZp_loccwdZtmpdirZfobjresrrr run_mod_cmd`s&    r.cCs@tj|}|j}dd|D}x|D]}|j||dq&WdS)z Extract all members from zipfile Deals with situation where the directory is stored in the zipfile as a name, as well as files that have to go into this directory. cSsg|]}|jds|qS)/)endswith).0mrrr sz#zip_extract_all..N)zipfileZipFilenamelistextract)fnamepathzfmemberszipinforrrzip_extract_alls   r=binc Csjtjj||}d|d|}tjjtj}td|d|}ztj|t|Wdtj|XdS)a Install package in `from_dir` to standard location in `to_dir` Parameters ---------- from_dir : str path containing files to install with ``python setup.py ...`` to_dir : str prefix path to which files will be installed, as in ``python setup.py install --prefix=to_dir`` py_lib_sdir : str, optional subdirectory within `to_dir` to which library code will be installed bin_sdir : str, optional subdirectory within `to_dir` to which scripts will be installed z --install-purelib=z --install-platlib=z# setup.py --quiet install --prefix= N)r!r9rrr"r(r%r)Zfrom_dirZto_dir py_lib_sdirZbin_sdirsite_pkgs_pathZ py_lib_locspwdrrrrinstall_from_tos  rCc CsLtj}z2t|||dkr"|}n||}t||||Wdtj|XdS)a Install package from zip file `zip_fname` Parameters ---------- zip_fname : str filename of zip file containing package code install_path : str output prefix at which to install package pkg_finder : None or callable, optional If None, assume zip contains ``setup.py`` at the top level. Otherwise, find directory containing ``setup.py`` with ``pth = pkg_finder(unzip_path)`` where ``unzip_path`` is the path to which we have unzipped the zip file contents. py_lib_sdir : str, optional subdirectory to which to write the library code from the package. Thus if package called ``nibabel``, the written code will be in ``//nibabel script_sdir : str, optional subdirectory to which we write the installed scripts. Thus scripts will be written to ``/ N)r#r$r=rCr)r*) zip_fname install_pathZ pkg_finderr@Z script_sdirZ unzip_path from_pathrrrinstall_from_zips rGc Cstjj|t}tjjtj}t|d}ztj|td|dWdtj|Xt ||dd|d}t t |||dt ||tt t |||dt t |||ddS)ap Print result of get_info from different installation routes Runs installation from: * git archive zip file * with setup.py install from repository directory * just running code from repository directory and prints out result of get_info in each case. There will be many files written into `install_path` that you may want to clean up somehow. Parameters ---------- mod_name : str package name that will be installed, and tested repo_path : str path to location of git repository install_path : str path into which to install temporary installations ztest.zipzgit archive --format zip -o z HEADNzprint(z .get_info())r) r!r9r PY_LIB_SDIRrr"pjoinr%rrGprintr.rC)r+ repo_pathrErArBZ out_fnameZcmd_strrrrcontexts_print_infos      rLc Cs:tjjtj}tj}zt|||Wdtj|XdS)a Run info context checks starting in working directory Runs checks from current working directory, installing temporary installations into a new temporary directory Parameters ---------- mod_name : str package name that will be installed, and tested N) r!r9rr"r#r$rLr)r*)r+rKrErrrinfo_from_heres rMc Cs~|dkrtjjtj}tj}t|t}t|d}z(t||tdt |||d|\}}Wdt j |Xt |t |dS)a Install from `source_path` into temporary directory; run tests Parameters ---------- mod_name : str name of module - e.g. 'nibabel' source_path : None or str Path from which to install. If None, defaults to working directory Nr>z.test()) r!r9rr"r#r$rIrHrCr.r)r*rJ)r+ source_pathrErA scripts_pathr r rrrtests_installed.s    rPcCst||ddS)ao Check files in `repo_mod_path` are installed at `install_mod_path` At the moment, all this does is check that all the ``*.py`` files in `repo_mod_path` are installed at `install_mod_path`. Parameters ---------- repo_mod_path : str repository path containing package files, e.g. /nibabel> install_mod_path : str path at which package has been installed. This is the path where the root package ``__init__.py`` lives. Return ------ uninstalled : list list of files that should have been installed, but have not been installed z\.py$)filter) missing_from) repo_mod_pathZinstall_mod_pathrrrcheck_installed_filesLsrTc Cs|dk rtj|}g}xttj|D]f\}}}|j||}xN|D]F}|dk rZ|j|dkrZq>tjj||} tjj| s>|j t ||q>Wq"W|S)a1 Return filenames present in `path0` but not in `path1` Parameters ---------- path0 : str path which contains all files of interest path1 : str path which should contain all files of interest filter : None or str or regexp, optional A successful result from ``filter.search(fname)`` means the file is of interest. None means all files are of interest Returns ------- path1_missing : list list of all files missing from `path1` that are in `path0` at the same relative path. N) recompiler!walkreplacesearchr9risfileappendrI) Zpath0path1rQ uninstalleddirpathdirnames filenamesZ out_dirpathr8Z equiv_fnamerrrrRcs    rRc Cs|dkrttj}tj}t||}t|t|}t|d}t|d}z@t||dd}t|} t ||| t|t ||d} t ||} Wdt j |X| rt ddj| nt d| rt d dj| nt d t| d kpt| d kS) zA Print library and script files not picked up during install Nr>zsdist --formats=zipz*.zipz\.py$zMissed library files: z, zYou got all the library fileszMissed script files: zYou got all the script filesr)rr!r"r#r$rIrH make_distget_sdist_finderrGrRr)r*rJrlen) r+rKZ scripts_sdirrErSZinstalled_mod_pathZrepo_binZ installed_binrDpfZ lib_missesZ script_missesrrr check_filess0       recsfdd}|S)zC Return function finding sdist source directory for `mod_name` cs.tt|d}t|dkr&td|dS)Nz-*z*There must be one and only one package dirr)rrIrcOSError)pthZpkg_dirs)r+rrrds zget_sdist_finder..pfr)r+rdr)r+rrbs rbfastc Cs|dkrttj}tj}zft||dd}t|}t|||tdt |t}t |d}|d|d|d} t ||| |\} } Wdt j |Xt | t | dS)z0 Make sdist zip, install from it, and run tests Nzsdist --formats=zipz*.zipr>z .test(label='z ', doctests=))rr!r"r#r$rarbrGrHrIr.r)r*rJ) r+rKlabeldoctestsrErDrdrAZ script_pathrr r rrr sdist_testss(    rmc Cs|dkrttj}tj}t|d}zDt||dd}t|||d|d|d}t||||\}} Wdt j |Xt |t | dS)a Make bdist_egg, unzip it, and run tests from result We've got a problem here, because the egg does not contain the scripts, and so, if we are testing the scripts with ``mod.test()``, we won't pick up the scripts from the repository we are testing. So, you might need to add a label to the script tests, and use the `label` parameter to indicate these should be skipped. As in: bdist_egg_tests('nibabel', None, label='not script_test') Nr> bdist_eggz*.eggz .test(label='z ', doctests=rj) rr!r"r#r$rIrar=r.r)r*rJ) r+rKrkrlrErOrDrr r rrrbdist_egg_testss$     roc Cstjjtj}z\tj|ttd|d|tt||}t |dkrjt d|ddj |dWdtj|X|d S) a Create distutils distribution file Parameters ---------- repo_path : str path to repository containing code and ``setup.py`` out_dir : str path to which to write new distribution file setup_params: str parameters to pass to ``setup.py`` to create distribution. zipglob : str glob identifying expected output file. Returns ------- out_fname : str filename of generated distribution file Examples -------- Make, return a zipped sdist:: make_dist('/path/to/repo', '/tmp/path', 'sdist --formats=zip', '*.zip') Make, return a binary egg:: make_dist('/path/to/repo', '/tmp/path', 'bdist_egg', '*.egg') z setup.py z --dist-dir=rfzThere must be one and only one z file, but I found "z: "Nr) r!r9rr"r%rr(rrIrcrgr)rKZout_dirZ setup_paramsZzipglobrBZzipsrrrras    ra)FT)NT)N)N)N)Nr>)NriT)NriT)&__doc__r!sysos.pathrrIrrr)r#r4rU subprocessrrnamer executabler(hasattrrrHrr.r=rCrGrLrMrPZ__test__rTrRrerbrmrorarrrrsB    / D  #)  "