Update setupbase

Author: vidartf

setup.py

@@ -5,7 +5,6 @@
 import sys
 
 from setupbase import (
-    setup,
     log,
     create_cmdclass,
     install_npm,
@@ -14,6 +13,8 @@
     get_version,
 )
 
+from setuptools import setup
+
 
 log.set_verbosity(log.DEBUG)
 log.info('setup.py entered')
@@ -26,12 +27,13 @@
 version = get_version(os.path.join(here, name, '_version.py'))
 
 
-cmdclass = create_cmdclass('js',
+cmdclass = create_cmdclass(
+    'js',
     data_files_spec=[
-        ('share/jupyter/nbextensions/jupyter-threejs', [
-            name + '/static/*.js',
-            name + '/static/*.js.map',
-        ]),
+        ('share/jupyter/nbextensions/jupyter-threejs',
+         name, 'static/*.js'),
+        ('share/jupyter/nbextensions/jupyter-threejs',
+         name, 'static/*.js.map'),
     ],
 )
 cmdclass['js'] = combine_commands(

setupbase.py

@@ -9,6 +9,7 @@
 contains a set of useful utilities for including npm packages
 within a Python package.
 """
+from collections import defaultdict
 from os.path import join as pjoin
 import io
 import os
@@ -20,12 +21,18 @@
 import sys
 
 
-from setuptools import Command, setup
-from setuptools.command.build_py import build_py
-from setuptools.command.sdist import sdist
+# BEFORE importing distutils, remove MANIFEST. distutils doesn't properly
+# update it when the contents of directories change.
+if os.path.exists('MANIFEST'): os.remove('MANIFEST')
+
+
+from distutils.cmd import Command
+from distutils.command.build_py import build_py
+from distutils.command.sdist import sdist
+from distutils import log
+
 from setuptools.command.develop import develop
 from setuptools.command.bdist_egg import bdist_egg
-from distutils import log
 
 try:
     from wheel.bdist_wheel import bdist_wheel
@@ -117,6 +124,17 @@ def update_package_data(distribution):
     build_py.finalize_options()
 
 
+class bdist_egg_disabled(bdist_egg):
+    """Disabled version of bdist_egg
+
+    Prevents setup.py install performing setuptools' default easy_install,
+    which it should never ever do.
+    """
+    def run(self):
+        sys.exit("Aborting implicit building of eggs. Use `pip install .` "
+                 " to install from source.")
+
+
 def create_cmdclass(prerelease_cmd=None, package_data_spec=None,
         data_files_spec=None):
     """Create a command class with the given optional prerelease class.
@@ -129,8 +147,9 @@ def create_cmdclass(prerelease_cmd=None, package_data_spec=None,
         A dictionary whose keys are the dotted package names and
         whose values are a list of glob patterns.
     data_files_spec: list, optional
-        A list of (path, patterns) tuples where the path is the
-        `data_files` install path and the patterns are glob patterns.
+        A list of (path, dname, pattern) tuples where the path is the
+        `data_files` install path, dname is the source directory, and the
+        pattern is a glob pattern.
 
     Notes
     -----
@@ -142,28 +161,35 @@ def create_cmdclass(prerelease_cmd=None, package_data_spec=None,
     name.
     e.g. `dict(foo=['./bar/*', './baz/**'])`
 
-    The data files glob patterns should be absolute paths or relative paths
-    from the root directory of the repository.
-    e.g. `('share/foo/bar', ['pkgname/bizz/*', 'pkgname/baz/**'])`
+    The data files directories should be absolute paths or relative paths
+    from the root directory of the repository.  Data files are specified
+    differently from `package_data` because we need a separate path entry
+    for each nested folder in `data_files`, and this makes it easier to
+    parse.
+    e.g. `('share/foo/bar', 'pkgname/bizz, '*')`
     """
-    egg = bdist_egg if 'bdist_egg' in sys.argv else bdist_egg_disabled
     wrapped = [prerelease_cmd] if prerelease_cmd else []
     if package_data_spec or data_files_spec:
         wrapped.append('handle_files')
     wrapper = functools.partial(_wrap_command, wrapped)
     handle_files = _get_file_handler(package_data_spec, data_files_spec)
 
+    if 'bdist_egg' in sys.argv:
+        egg = wrapper(bdist_egg, strict=True)
+    else:
+        egg = bdist_egg_disabled
+
     cmdclass = dict(
         build_py=wrapper(build_py, strict=is_repo),
-        sdist=wrapper(sdist, strict=True),
         bdist_egg=egg,
-        develop=wrapper(develop, strict=True),
+        sdist=wrapper(sdist, strict=True),
         handle_files=handle_files,
     )
 
     if bdist_wheel:
         cmdclass['bdist_wheel'] = wrapper(bdist_wheel, strict=True)
 
+    cmdclass['develop'] = wrapper(develop, strict=True)
     return cmdclass
 
 
@@ -221,6 +247,7 @@ def combine_commands(*commands):
     """Return a Command that combines several commands."""
 
     class CombinedCommand(Command):
+        user_options = []
 
         def initialize_options(self):
             self.commands = []
@@ -448,23 +475,14 @@ def run(self):
 
             update_packages(self)
 
-            result = cls.run(self)
             # update package data
             update_package_data(self.distribution)
+
+            result = cls.run(self)
             return result
     return WrappedCommand
 
 
-class bdist_egg_disabled(bdist_egg):
-    """Disabled version of bdist_egg
-    Prevents setup.py install performing setuptools' default easy_install,
-    which it should never ever do.
-    """
-    def run(self):
-        sys.exit("Aborting implicit building of eggs. Use `pip install .` " +
-                 " to install from source.")
-
-
 def _get_file_handler(package_data_spec, data_files_spec):
     """Get a package_data and data_files handler command.
     """
@@ -473,20 +491,58 @@ class FileHandler(BaseCommand):
         def run(self):
             package_data = self.distribution.package_data
             package_spec = package_data_spec or dict()
-            data_spec = data_files_spec or []
 
             for (key, patterns) in package_spec.items():
                 package_data[key] = _get_package_data(key, patterns)
 
-            data_files = self.distribution.data_files or []
-            for (path, patterns) in data_spec:
-                data_files.append((path, _get_files(patterns)))
-
-            self.distribution.data_files = data_files
+            self.distribution.data_files = _get_data_files(
+                data_files_spec, self.distribution.data_files
+            )
 
     return FileHandler
 
 
+def _get_data_files(data_specs, existing):
+    """Expand data file specs into valid data files metadata.
+
+    Parameters
+    ----------
+    data_specs: list of tuples
+        See [createcmdclass] for description.
+    existing: list of tuples
+        The existing distrubution data_files metadata.
+
+    Returns
+    -------
+    A valid list of data_files items.
+    """
+    # Extract the existing data files into a staging object.
+    file_data = defaultdict(list)
+    for (path, files) in existing or []:
+        file_data[path] = files
+
+    # Extract the files and assign them to the proper data
+    # files path.
+    for (path, dname, pattern) in data_specs or []:
+        dname = dname.replace(os.sep, '/')
+        offset = len(dname) + 1
+
+        files = _get_files(pjoin(dname, pattern))
+        for fname in files:
+            # Normalize the path.
+            root = os.path.dirname(fname)
+            full_path = '/'.join([path, root[offset:]])
+            if full_path.endswith('/'):
+                full_path = full_path[:-1]
+            file_data[full_path].append(fname)
+
+    # Construct the data files spec.
+    data_files = []
+    for (path, files) in file_data.items():
+        data_files.append((path, files))
+    return data_files
+
+
 def _get_files(file_patterns, top=HERE):
     """Expand file patterns to a list of paths.
 
@@ -621,7 +677,7 @@ def _translate_glob_part(pat):
     res = []
     while i < n:
         c = pat[i]
-        i = i+1
+        i = i + 1
         if c == '*':
             # Match anything but path separators:
             res.append('[^%s]*' % SEPARATORS)
@@ -630,16 +686,16 @@ def _translate_glob_part(pat):
         elif c == '[':
             j = i
             if j < n and pat[j] == '!':
-                j = j+1
+                j = j + 1
             if j < n and pat[j] == ']':
-                j = j+1
+                j = j + 1
             while j < n and pat[j] != ']':
-                j = j+1
+                j = j + 1
             if j >= n:
                 res.append('\\[')
             else:
                 stuff = pat[i:j].replace('\\', '\\\\')
-                i = j+1
+                i = j + 1
                 if stuff[0] == '!':
                     stuff = '^' + stuff[1:]
                 elif stuff[0] == '^':