setup.py 7.05 KB
Newer Older
Nicolas Chauvat's avatar
Nicolas Chauvat committed
1
#!/usr/bin/env python
2
3
# pylint: disable=W0142,W0403,W0404,W0613,W0622,W0622,W0704,R0904,C0103,E0611
#
4
# copyright 2003-2016 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
5
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
6
#
7
# This file is part of a CubicWeb cube.
8
9
10
11
12
13
14
15
16
17
18
#
# 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
# Software Foundation, either version 2.1 of the License, or (at your option)
# any later version.
#
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
# details.
#
19
20
# You should have received a copy of the GNU Lesser General Public License
# along with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
21
22
"""Generic Setup script, takes package info from __pkginfo__.py file
"""
23
24
25
26
27
__docformat__ = "restructuredtext en"

import os
import sys
import shutil
28
from os.path import exists, join, dirname
29
30
31

try:
    if os.environ.get('NO_SETUPTOOLS'):
32
        raise ImportError()  # do as there is no setuptools
33
34
    from setuptools import setup
    from setuptools.command import install_lib
35
    USE_SETUPTOOLS = True
36
37
38
except ImportError:
    from distutils.core import setup
    from distutils.command import install_lib
39
40
    USE_SETUPTOOLS = False
from distutils.command import install_data
41
42


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# 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(join(base_dir, "__pkginfo__.py")) as f:
    exec(f.read(), pkginfo)

# 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']

with open(join(base_dir, 'README')) as f:
    long_description = f.read()

# 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', ())
69

70
if USE_SETUPTOOLS:
71
    requires = {}
72
73
    for entry in ("__depends__",):  # "__recommends__"):
        requires.update(pkginfo.get(entry, {}))
74
    install_requires = [("%s %s" % (d, v and v or "")).strip()
75
                        for d, v in requires.items()]
76
else:
77
78
    install_requires = []

79
BASE_BLACKLIST = ('CVS', '.svn', '.hg', '.git', 'debian', 'dist', 'build')
80
IGNORED_EXTENSIONS = ('.pyc', '.pyo', '.elc', '~')
81
82
83


def ensure_scripts(linux_scripts):
84
85
    """
    Creates the proper script names required for each platform
86
87
88
89
90
91
92
93
94
    (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_

95

96
def export(from_dir, to_dir,
97
           blacklist=BASE_BLACKLIST,
98
99
           ignore_ext=IGNORED_EXTENSIONS,
           verbose=True):
100
101
102
103
104
105
106
107
    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):
108
109
        for norecurs in blacklist:
            try:
110
                dirnames.remove(norecurs)
111
112
            except ValueError:
                pass
113
114
115
116
117
        for dir_name in dirnames:
            dest = join(to_dir, dir_name)
            if not exists(dest):
                os.mkdir(dest)
        for filename in filenames:
118
            # don't include binary files
119
120
            src = join(dirpath, filename)
            dest = to_dir + src[len(from_dir):]
121
122
123
124
            if filename[-4:] in ignore_ext:
                continue
            if filename[-1] == '~':
                continue
125
126
            if exists(dest):
                os.remove(dest)
127
            if verbose:
128
129
                sys.stderr.write('%s -> %s\n' % (src, dest))
            shutil.copy2(src, dest)
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144


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)
Nicolas Chauvat's avatar
Nicolas Chauvat committed
145

146

147
148
149
150
151
152
153
154
155
156
157
158
159
# 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:
160
161
        # only if easy_install available
        import setuptools.command.easy_install  # noqa
162
163
164
        # monkey patch: Crack SandboxViolation verification
        from setuptools.sandbox import DirectorySandbox as DS
        old_ok = DS._ok
165

166
167
        def _ok(self, path):
            """Return True if ``path`` can be written during installation."""
168
            out = old_ok(self, path)  # here for side effect from setuptools
169
170
171
172
173
174
175
176
177
            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

178

Nicolas Chauvat's avatar
Nicolas Chauvat committed
179
180
def install(**kwargs):
    """setup entry point"""
181
182
183
184
185
186
    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')
187
188
    cmdclass = {'install_lib': MyInstallLib}
    if USE_SETUPTOOLS:
189
190
        kwargs['install_requires'] = install_requires
        kwargs['dependency_links'] = dependency_links
191
192
193
        kwargs['zip_safe'] = False
        cmdclass['install_data'] = MyInstallData

194
195
196
197
198
199
200
201
202
203
204
205
    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,
206
207
                 **kwargs
                 )
208

209
210

if __name__ == '__main__':
Nicolas Chauvat's avatar
Nicolas Chauvat committed
211
    install()