BF - updated nisext

Author: matthew-brett

nisext/__init__.py

@@ -1 +1,28 @@
 # init for sext package
+""" Setuptools extensions that can be shared across projects
+
+Typical use for these routines is as a git subtree merge
+
+For example::
+
+    # Add a remote pointing to repository
+    git remote add nisext git://github.com/nipy/nisext.git
+    git fetch nisext
+    # Label nisext history as merged
+    git merge -s ours --no-commit nisext/master
+    # Read nisext contents as nisext subdirectory
+    git read-tree --prefix=nisext/ -u nisext/master
+    git commit -m "Merge nisext project as subtree"
+
+Then you would typically add a makefile target like::
+
+    # Update nisext subtree from remote
+    update-nisext:
+            git fetch nisext
+            git merge --squash -s subtree --no-commit nisext/master
+
+and commit when you have changes you want. This allows you to keep the nisext
+tree updated from the upstream repository, but the tree will be there and ready
+for someone without this machinery or remote.
+"""
+

nisext/sexts.py

@@ -8,8 +8,42 @@
 
 from distutils import log
 
-def get_build_cmd(pkg_dir):
-    class MyBuildPy(build_py):
+def get_comrec_build(pkg_dir, build_cmd=build_py):
+    """ Return extended build command class for recording commit
+
+    The extended command tries to run git to find the current commit, getting
+    the empty string if it fails.  It then writes the commit hash into a file
+    in the `pkg_dir` path, named ``COMMIT_INFO.txt``.
+
+    In due course this information can be used by the package after it is
+    installed, to tell you what commit it was installed from if known.
+
+    To make use of this system, you need a package with a COMMIT_INFO.txt file -
+    e.g. ``myproject/COMMIT_INFO.txt`` - that might well look like this::
+
+        # This is an ini file that may contain information about the code state
+        [commit hash]
+        # The line below may contain a valid hash if it has been substituted during 'git archive'
+        archive_subst_hash=$Format:%h$
+        # This line may be modified by the install process
+        install_hash=
+
+    The COMMIT_INFO file above is also designed to be used with git substitution
+    - so you probably also want a ``.gitattributes`` file in the root directory
+    of your working tree that contains something like this::
+
+       myproject/COMMIT_INFO.txt export-subst
+
+    That will cause the ``COMMIT_INFO.txt`` file to get filled in by ``git
+    archive`` - useful in case someone makes such an archive - for example with
+    via the github 'download source' button.
+
+    Although all the above will work as is, you might consider having something
+    like a ``get_info()`` function in your package to display the commit
+    information at the terminal.  See the ``pkg_info.py`` module in the nipy
+    package for an example.
+    """
+    class MyBuildPy(build_cmd):
         ''' Subclass to write commit data into installation tree '''
         def run(self):
             build_py.run(self)

nisext/testers.py

@@ -1,4 +1,14 @@
 ''' Test package information in various install settings
+
+The routines here install the package in various settings and print out the
+corresponding version info from the installation.
+
+The typical use for this module is as a makefile target, as in::
+
+    # Print out info for possible install methods
+    check-version-info:
+        python -c 'from nisext.testers import info_from_here; info_from_here("mypackage")'
+
 '''
 
 import os
@@ -32,7 +42,7 @@ def sys_print_info(mod_name, pkg_path):
         shutil.rmtree(tmpdir)
 
 
-def zip_extract_all(fname):
+def zip_extract_all(fname, path=None):
     ''' Extract all members from zipfile
 
     Deals with situation where the directory is stored in the zipfile as a name,
@@ -42,7 +52,61 @@ def zip_extract_all(fname):
     members = zf.namelist()
     # Remove members that are just bare directories
     members = [m for m in members if not m.endswith('/')]
-    zf.extractall(members = members)
+    for zipinfo in members:
+        zf.extract(zipinfo, path, None)
+
+
+def install_from_to(from_dir, to_dir, py_lib_sdir):
+    """ Install package in `from_dir` to standard location in `to_dir`
+
+    Return path to directory containing package directory. The package directory
+    is the directory containing __init__.py
+    """
+    site_pkgs_path = os.path.join(to_dir, py_lib_sdir)
+    py_lib_locs = ' --install-purelib=%s --install-platlib=%s' % (
+        site_pkgs_path, site_pkgs_path)
+    pwd = os.path.abspath(os.getcwd())
+    try:
+        os.chdir(from_dir)
+        my_call('python setup.py --quiet install --prefix=%s %s' % (to_dir,
+                                                                    py_lib_locs))
+    finally:
+        os.chdir(pwd)
+    return site_pkgs_path
+
+
+def check_installed_files(repo_mod_path, install_mod_path):
+    """ 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-repo>/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
+    """
+    repo_mod_path = os.path.abspath(repo_mod_path)
+    uninstalled = []
+    # Walk directory tree to get py files
+    for dirpath, dirnames, filenames in os.walk(repo_mod_path):
+        out_dirpath = dirpath.replace(repo_mod_path, install_mod_path)
+        for fname in filenames:
+            if not fname.lower().endswith('.py'):
+                continue
+            equiv_fname = os.path.join(out_dirpath, fname)
+            if not os.path.isfile(equiv_fname):
+                uninstalled.append(pjoin(dirpath, fname))
+    return uninstalled
 
 
 def contexts_print_info(mod_name, repo_path, install_path):
@@ -54,7 +118,8 @@ def contexts_print_info(mod_name, repo_path, install_path):
     * with setup.py install from repository directory
     * just running code from repository directory
 
-    and prints out result of get_info in each case
+    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
     ----------
@@ -69,21 +134,29 @@ def contexts_print_info(mod_name, repo_path, install_path):
     py_lib_locs = ' --install-purelib=%s --install-platlib=%s' % (
         site_pkgs_path, site_pkgs_path)
     # first test archive
-    os.chdir(repo_path)
+    pwd = os.path.abspath(os.getcwd())
     out_fname = pjoin(install_path, 'test.zip')
-    my_call('git archive --format zip -o %s master' % out_fname)
-    os.chdir(install_path)
-    zip_extract_all('test.zip')
-    my_call('python setup.py --quiet install --prefix=%s %s' % (install_path,
-                                                                py_lib_locs))
+    try:
+        os.chdir(repo_path)
+        my_call('git archive --format zip -o %s HEAD' % out_fname)
+    finally:
+        os.chdir(pwd)
+    install_from = pjoin(install_path, mod_name)
+    zip_extract_all(out_fname, install_from)
+    site_pkgs_path = install_from_to(install_from,
+                                     install_path,
+                                     PY_LIB_SDIR)
     sys_print_info(mod_name, site_pkgs_path)
-    # remove installation
-    shutil.rmtree(site_pkgs_path)
     # now test install into a directory from the repository
-    os.chdir(repo_path)
-    my_call('python setup.py --quiet install --prefix=%s %s' % (install_path,
-                                                                py_lib_locs))
+    site_pkgs_path = install_from_to(repo_path,
+                                     install_path,
+                                     PY_LIB_SDIR)
     sys_print_info(mod_name, site_pkgs_path)
+    # Take the opportunity to audit the py files
+    repo_mod_path = os.path.join(repo_path, mod_name)
+    install_mod_path = os.path.join(site_pkgs_path, mod_name)
+    print 'Files not taken across by the installation:'
+    print check_installed_files(repo_mod_path, install_mod_path)
     # test from development tree
     sys_print_info(mod_name, repo_path)
     return
@@ -106,3 +179,5 @@ def info_from_here(mod_name):
         contexts_print_info(mod_name, repo_path, install_path)
     finally:
         shutil.rmtree(install_path)
+
+

setup.py

@@ -32,8 +32,8 @@
 if not 'extra_setuptools_args' in globals():
     extra_setuptools_args = dict()
 
-from nisext.sexts import get_build_cmd, package_check
-cmdclass = {'build_py': get_build_cmd('nibabel')}
+from nisext.sexts import get_comrec_build, package_check
+cmdclass = {'build_py': get_comrec_build('nibabel')}
 
 # Get version and release info, which is all stored in nibabel/info.py
 ver_file = os.path.join('nibabel', 'info.py')