[pkg] copy setup.py from current cubicweb skeleton 1.12.0 centos/1.12.0-1 debian/1.12.0-1
authorJulien Cristau <julien.cristau@logilab.fr>
Mon, 14 Mar 2016 17:02:06 +0100
changeset 359 9d56a56cffc5
parent 357 6da9ea880340
child 360 70134ef83e01
[pkg] copy setup.py from current cubicweb skeleton
setup.py
--- a/setup.py	Mon Mar 14 16:46:10 2016 +0100
+++ b/setup.py	Mon Mar 14 17:02:06 2016 +0100
@@ -1,10 +1,10 @@
 #!/usr/bin/env python
 # pylint: disable=W0142,W0403,W0404,W0613,W0622,W0622,W0704,R0904,C0103,E0611
 #
-# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
+# copyright 2003-2016 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
 # contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
 #
-# This file is part of CubicWeb blog cube.
+# This file is part of a CubicWeb cube.
 #
 # CubicWeb is free software: you can redistribute it and/or modify it under the
 # terms of the GNU Lesser General Public License as published by the Free
@@ -16,50 +16,198 @@
 # FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 # details.
 #
-# You should have received a copy of the GNU Lesser General Public License along
-# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
+# You should have received a copy of the GNU Lesser General Public License
+# along with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
 """Generic Setup script, takes package info from __pkginfo__.py file
 """
 __docformat__ = "restructuredtext en"
 
-from setuptools import setup
 import os
 import sys
-from io import open
+import shutil
+from os.path import exists, join, dirname
 
-here = os.path.abspath(os.path.dirname(__file__))
+try:
+    if os.environ.get('NO_SETUPTOOLS'):
+        raise ImportError()  # do as there is no setuptools
+    from setuptools import setup
+    from setuptools.command import install_lib
+    USE_SETUPTOOLS = True
+except ImportError:
+    from distutils.core import setup
+    from distutils.command import install_lib
+    USE_SETUPTOOLS = False
+from distutils.command import install_data
 
+
+# load metadata from the __pkginfo__.py file so there is no risk of conflict
+# see https://packaging.python.org/en/latest/single_source_version.html
+base_dir = dirname(__file__)
 pkginfo = {}
-with open(os.path.join(here, '__pkginfo__.py')) as f:
+with open(join(base_dir, "__pkginfo__.py")) as f:
     exec(f.read(), pkginfo)
 
-# Get the long description from the relevant file
-with open(os.path.join(here, 'README'), encoding='utf-8') as f:
+# get required metadatas
+modname = pkginfo['modname']
+version = pkginfo['version']
+license = pkginfo['license']
+description = pkginfo['description']
+web = pkginfo['web']
+author = pkginfo['author']
+author_email = pkginfo['author_email']
+classifiers = pkginfo['classifiers']
+
+with open(join(base_dir, 'README')) as f:
     long_description = f.read()
 
-# import optional features
-requires = pkginfo['__depends__']
-install_requires = [("%s %s" % (d, v and v or "")).strip()
-                    for d, v in requires.items()]
+# get optional metadatas
+distname = pkginfo.get('distname', modname)
+scripts = pkginfo.get('scripts', ())
+include_dirs = pkginfo.get('include_dirs', ())
+data_files = pkginfo.get('data_files', None)
+ext_modules = pkginfo.get('ext_modules', None)
+dependency_links = pkginfo.get('dependency_links', ())
 
-BASE_BLACKLIST = ('CVS', '.svn', '.hg', 'debian', 'dist', 'build')
+if USE_SETUPTOOLS:
+    requires = {}
+    for entry in ("__depends__",):  # "__recommends__"):
+        requires.update(pkginfo.get(entry, {}))
+    install_requires = [("%s %s" % (d, v and v or "")).strip()
+                        for d, v in requires.items()]
+else:
+    install_requires = []
+
+BASE_BLACKLIST = ('CVS', '.svn', '.hg', '.git', 'debian', 'dist', 'build')
 IGNORED_EXTENSIONS = ('.pyc', '.pyo', '.elc', '~')
 
-if '--force-manifest' in sys.argv:
-    sys.argv.remove('--force-manifest')
+
+def ensure_scripts(linux_scripts):
+    """
+    Creates the proper script names required for each platform
+    (taken from 4Suite)
+    """
+    from distutils import util
+    if util.get_platform()[:3] == 'win':
+        scripts_ = [script + '.bat' for script in linux_scripts]
+    else:
+        scripts_ = linux_scripts
+    return scripts_
+
+
+def export(from_dir, to_dir,
+           blacklist=BASE_BLACKLIST,
+           ignore_ext=IGNORED_EXTENSIONS,
+           verbose=True):
+    try:
+        os.mkdir(to_dir)
+    except OSError as ex:
+        # file exists ?
+        import errno
+        if ex.errno != errno.EEXIST:
+            raise
+    for dirpath, dirnames, filenames in os.walk(from_dir):
+        for norecurs in blacklist:
+            try:
+                dirnames.remove(norecurs)
+            except ValueError:
+                pass
+        for dir_name in dirnames:
+            dest = join(to_dir, dir_name)
+            if not exists(dest):
+                os.mkdir(dest)
+        for filename in filenames:
+            # don't include binary files
+            src = join(dirpath, filename)
+            dest = to_dir + src[len(from_dir):]
+            if filename[-4:] in ignore_ext:
+                continue
+            if filename[-1] == '~':
+                continue
+            if exists(dest):
+                os.remove(dest)
+            if verbose:
+                sys.stderr.write('%s -> %s\n' % (src, dest))
+            shutil.copy2(src, dest)
+
+
+class MyInstallLib(install_lib.install_lib):
+    """extend install_lib command to handle  package __init__.py and
+    include_dirs variable if necessary
+    """
+    def run(self):
+        """overridden from install_lib class"""
+        install_lib.install_lib.run(self)
+        # manually install included directories if any
+        if include_dirs:
+            base = modname
+            for directory in include_dirs:
+                dest = join(self.install_dir, base, directory)
+                export(directory, dest, verbose=False)
+
 
-setup(
-    name=pkginfo['distname'],
-    version=pkginfo['version'],
-    description=pkginfo['description'],
-    long_description=long_description,
-    url=pkginfo['web'],
-    author=pkginfo['author'],
-    author_email=pkginfo['author_email'],
-    license=pkginfo['license'],
-    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
-    classifiers=pkginfo['classifiers'],
-    data_files=pkginfo['data_files'],
-    install_requires=install_requires,
-    zip_safe=False
-)
+# re-enable copying data files in sys.prefix
+old_install_data = install_data.install_data
+if USE_SETUPTOOLS:
+    # overwrite InstallData to use sys.prefix instead of the egg directory
+    class MyInstallData(old_install_data):
+        """A class that manages data files installation"""
+        def run(self):
+            _old_install_dir = self.install_dir
+            if self.install_dir.endswith('egg'):
+                self.install_dir = sys.prefix
+            old_install_data.run(self)
+            self.install_dir = _old_install_dir
+    try:
+        # only if easy_install available
+        import setuptools.command.easy_install  # noqa
+        # monkey patch: Crack SandboxViolation verification
+        from setuptools.sandbox import DirectorySandbox as DS
+        old_ok = DS._ok
+
+        def _ok(self, path):
+            """Return True if ``path`` can be written during installation."""
+            out = old_ok(self, path)  # here for side effect from setuptools
+            realpath = os.path.normcase(os.path.realpath(path))
+            allowed_path = os.path.normcase(sys.prefix)
+            if realpath.startswith(allowed_path):
+                out = True
+            return out
+        DS._ok = _ok
+    except ImportError:
+        pass
+
+
+def install(**kwargs):
+    """setup entry point"""
+    if USE_SETUPTOOLS:
+        if '--force-manifest' in sys.argv:
+            sys.argv.remove('--force-manifest')
+    # install-layout option was introduced in 2.5.3-1~exp1
+    elif sys.version_info < (2, 5, 4) and '--install-layout=deb' in sys.argv:
+        sys.argv.remove('--install-layout=deb')
+    cmdclass = {'install_lib': MyInstallLib}
+    if USE_SETUPTOOLS:
+        kwargs['install_requires'] = install_requires
+        kwargs['dependency_links'] = dependency_links
+        kwargs['zip_safe'] = False
+        cmdclass['install_data'] = MyInstallData
+
+    return setup(name=distname,
+                 version=version,
+                 license=license,
+                 description=description,
+                 long_description=long_description,
+                 author=author,
+                 author_email=author_email,
+                 url=web,
+                 scripts=ensure_scripts(scripts),
+                 data_files=data_files,
+                 ext_modules=ext_modules,
+                 cmdclass=cmdclass,
+                 classifiers=classifiers,
+                 **kwargs
+                 )
+
+
+if __name__ == '__main__':
+    install()