|
| 1 | + |
| 2 | +#!python |
| 3 | +"""Bootstrap setuptools installation |
| 4 | +
|
| 5 | +If you want to use setuptools in your package's setup.py, just include this |
| 6 | +file in the same directory with it, and add this to the top of your setup.py:: |
| 7 | +
|
| 8 | +from ez_setup import use_setuptools |
| 9 | +use_setuptools() |
| 10 | +
|
| 11 | +If you want to require a specific version of setuptools, set a download |
| 12 | +mirror, or use an alternate download directory, you can do so by supplying |
| 13 | +the appropriate options to ``use_setuptools()``. |
| 14 | +
|
| 15 | +This file can also be run as a script to install or upgrade setuptools. |
| 16 | +""" |
| 17 | +import os |
| 18 | +import shutil |
| 19 | +import sys |
| 20 | +import tempfile |
| 21 | +import tarfile |
| 22 | +import optparse |
| 23 | +import subprocess |
| 24 | + |
| 25 | +from distutils import log |
| 26 | + |
| 27 | +try: |
| 28 | + from site import USER_SITE |
| 29 | +except ImportError: |
| 30 | + USER_SITE = None |
| 31 | + |
| 32 | +DEFAULT_VERSION = "0.9.6" |
| 33 | +DEFAULT_URL = "https://pypi.python.org/packages/source/s/setuptools/" |
| 34 | + |
| 35 | +def _python_cmd(*args): |
| 36 | + args = (sys.executable,) + args |
| 37 | + return subprocess.call(args) == 0 |
| 38 | + |
| 39 | +def _install(tarball, install_args=()): |
| 40 | + # extracting the tarball |
| 41 | + tmpdir = tempfile.mkdtemp() |
| 42 | + log.warn('Extracting in %s', tmpdir) |
| 43 | + old_wd = os.getcwd() |
| 44 | + try: |
| 45 | + os.chdir(tmpdir) |
| 46 | + tar = tarfile.open(tarball) |
| 47 | + _extractall(tar) |
| 48 | + tar.close() |
| 49 | + |
| 50 | + # going in the directory |
| 51 | + subdir = os.path.join(tmpdir, os.listdir(tmpdir)[0]) |
| 52 | + os.chdir(subdir) |
| 53 | + log.warn('Now working in %s', subdir) |
| 54 | + |
| 55 | + # installing |
| 56 | + log.warn('Installing Setuptools') |
| 57 | + if not _python_cmd('setup.py', 'install', *install_args): |
| 58 | + log.warn('Something went wrong during the installation.') |
| 59 | + log.warn('See the error message above.') |
| 60 | + # exitcode will be 2 |
| 61 | + return 2 |
| 62 | + finally: |
| 63 | + os.chdir(old_wd) |
| 64 | + shutil.rmtree(tmpdir) |
| 65 | + |
| 66 | + |
| 67 | +def _build_egg(egg, tarball, to_dir): |
| 68 | + # extracting the tarball |
| 69 | + tmpdir = tempfile.mkdtemp() |
| 70 | + log.warn('Extracting in %s', tmpdir) |
| 71 | + old_wd = os.getcwd() |
| 72 | + try: |
| 73 | + os.chdir(tmpdir) |
| 74 | + tar = tarfile.open(tarball) |
| 75 | + _extractall(tar) |
| 76 | + tar.close() |
| 77 | + |
| 78 | + # going in the directory |
| 79 | + subdir = os.path.join(tmpdir, os.listdir(tmpdir)[0]) |
| 80 | + os.chdir(subdir) |
| 81 | + log.warn('Now working in %s', subdir) |
| 82 | + |
| 83 | + # building an egg |
| 84 | + log.warn('Building a Setuptools egg in %s', to_dir) |
| 85 | + _python_cmd('setup.py', '-q', 'bdist_egg', '--dist-dir', to_dir) |
| 86 | + |
| 87 | + finally: |
| 88 | + os.chdir(old_wd) |
| 89 | + shutil.rmtree(tmpdir) |
| 90 | + # returning the result |
| 91 | + log.warn(egg) |
| 92 | + if not os.path.exists(egg): |
| 93 | + raise IOError('Could not build the egg.') |
| 94 | + |
| 95 | + |
| 96 | +def _do_download(version, download_base, to_dir, download_delay): |
| 97 | + egg = os.path.join(to_dir, 'setuptools-%s-py%d.%d.egg' |
| 98 | + % (version, sys.version_info[0], sys.version_info[1])) |
| 99 | + if not os.path.exists(egg): |
| 100 | + tarball = download_setuptools(version, download_base, |
| 101 | + to_dir, download_delay) |
| 102 | + _build_egg(egg, tarball, to_dir) |
| 103 | + sys.path.insert(0, egg) |
| 104 | + import setuptools |
| 105 | + setuptools.bootstrap_install_from = egg |
| 106 | + |
| 107 | + |
| 108 | +def use_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL, |
| 109 | + to_dir=os.curdir, download_delay=15): |
| 110 | + # making sure we use the absolute path |
| 111 | + to_dir = os.path.abspath(to_dir) |
| 112 | + was_imported = 'pkg_resources' in sys.modules or \ |
| 113 | + 'setuptools' in sys.modules |
| 114 | + try: |
| 115 | + import pkg_resources |
| 116 | + except ImportError: |
| 117 | + return _do_download(version, download_base, to_dir, download_delay) |
| 118 | + try: |
| 119 | + pkg_resources.require("setuptools>=" + version) |
| 120 | + return |
| 121 | + except pkg_resources.VersionConflict: |
| 122 | + e = sys.exc_info()[1] |
| 123 | + if was_imported: |
| 124 | + sys.stderr.write( |
| 125 | + "The required version of setuptools (>=%s) is not available,\n" |
| 126 | + "and can't be installed while this script is running. Please\n" |
| 127 | + "install a more recent version first, using\n" |
| 128 | + "'easy_install -U setuptools'." |
| 129 | + "\n\n(Currently using %r)\n" % (version, e.args[0])) |
| 130 | + sys.exit(2) |
| 131 | + else: |
| 132 | + del pkg_resources, sys.modules['pkg_resources'] # reload ok |
| 133 | + return _do_download(version, download_base, to_dir, |
| 134 | + download_delay) |
| 135 | + except pkg_resources.DistributionNotFound: |
| 136 | + return _do_download(version, download_base, to_dir, |
| 137 | + download_delay) |
| 138 | + |
| 139 | + |
| 140 | +def download_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL, |
| 141 | + to_dir=os.curdir, delay=15): |
| 142 | + """Download setuptools from a specified location and return its filename |
| 143 | +
|
| 144 | +`version` should be a valid setuptools version number that is available |
| 145 | +as an egg for download under the `download_base` URL (which should end |
| 146 | +with a '/'). `to_dir` is the directory where the egg will be downloaded. |
| 147 | +`delay` is the number of seconds to pause before an actual download |
| 148 | +attempt. |
| 149 | +""" |
| 150 | + # making sure we use the absolute path |
| 151 | + to_dir = os.path.abspath(to_dir) |
| 152 | + try: |
| 153 | + from urllib.request import urlopen |
| 154 | + except ImportError: |
| 155 | + from urllib2 import urlopen |
| 156 | + tgz_name = "setuptools-%s.tar.gz" % version |
| 157 | + url = download_base + tgz_name |
| 158 | + saveto = os.path.join(to_dir, tgz_name) |
| 159 | + src = dst = None |
| 160 | + if not os.path.exists(saveto): # Avoid repeated downloads |
| 161 | + try: |
| 162 | + log.warn("Downloading %s", url) |
| 163 | + src = urlopen(url) |
| 164 | + # Read/write all in one block, so we don't create a corrupt file |
| 165 | + # if the download is interrupted. |
| 166 | + data = src.read() |
| 167 | + dst = open(saveto, "wb") |
| 168 | + dst.write(data) |
| 169 | + finally: |
| 170 | + if src: |
| 171 | + src.close() |
| 172 | + if dst: |
| 173 | + dst.close() |
| 174 | + return os.path.realpath(saveto) |
| 175 | + |
| 176 | + |
| 177 | +def _extractall(self, path=".", members=None): |
| 178 | + """Extract all members from the archive to the current working |
| 179 | +directory and set owner, modification time and permissions on |
| 180 | +directories afterwards. `path' specifies a different directory |
| 181 | +to extract to. `members' is optional and must be a subset of the |
| 182 | +list returned by getmembers(). |
| 183 | +""" |
| 184 | + import copy |
| 185 | + import operator |
| 186 | + from tarfile import ExtractError |
| 187 | + directories = [] |
| 188 | + |
| 189 | + if members is None: |
| 190 | + members = self |
| 191 | + |
| 192 | + for tarinfo in members: |
| 193 | + if tarinfo.isdir(): |
| 194 | + # Extract directories with a safe mode. |
| 195 | + directories.append(tarinfo) |
| 196 | + tarinfo = copy.copy(tarinfo) |
| 197 | + tarinfo.mode = 448 # decimal for oct 0700 |
| 198 | + self.extract(tarinfo, path) |
| 199 | + |
| 200 | + # Reverse sort directories. |
| 201 | + if sys.version_info < (2, 4): |
| 202 | + def sorter(dir1, dir2): |
| 203 | + return cmp(dir1.name, dir2.name) |
| 204 | + directories.sort(sorter) |
| 205 | + directories.reverse() |
| 206 | + else: |
| 207 | + directories.sort(key=operator.attrgetter('name'), reverse=True) |
| 208 | + |
| 209 | + # Set correct owner, mtime and filemode on directories. |
| 210 | + for tarinfo in directories: |
| 211 | + dirpath = os.path.join(path, tarinfo.name) |
| 212 | + try: |
| 213 | + self.chown(tarinfo, dirpath) |
| 214 | + self.utime(tarinfo, dirpath) |
| 215 | + self.chmod(tarinfo, dirpath) |
| 216 | + except ExtractError: |
| 217 | + e = sys.exc_info()[1] |
| 218 | + if self.errorlevel > 1: |
| 219 | + raise |
| 220 | + else: |
| 221 | + self._dbg(1, "tarfile: %s" % e) |
| 222 | + |
| 223 | + |
| 224 | +def _build_install_args(options): |
| 225 | + """ |
| 226 | +Build the arguments to 'python setup.py install' on the setuptools package |
| 227 | +""" |
| 228 | + install_args = [] |
| 229 | + if options.user_install: |
| 230 | + if sys.version_info < (2, 6): |
| 231 | + log.warn("--user requires Python 2.6 or later") |
| 232 | + raise SystemExit(1) |
| 233 | + install_args.append('--user') |
| 234 | + return install_args |
| 235 | + |
| 236 | +def _parse_args(): |
| 237 | + """ |
| 238 | +Parse the command line for options |
| 239 | +""" |
| 240 | + parser = optparse.OptionParser() |
| 241 | + parser.add_option( |
| 242 | + '--user', dest='user_install', action='store_true', default=False, |
| 243 | + help='install in user site package (requires Python 2.6 or later)') |
| 244 | + parser.add_option( |
| 245 | + '--download-base', dest='download_base', metavar="URL", |
| 246 | + default=DEFAULT_URL, |
| 247 | + help='alternative URL from where to download the setuptools package') |
| 248 | + options, args = parser.parse_args() |
| 249 | + # positional arguments are ignored |
| 250 | + return options |
| 251 | + |
| 252 | +def main(version=DEFAULT_VERSION): |
| 253 | + """Install or upgrade setuptools and EasyInstall""" |
| 254 | + options = _parse_args() |
| 255 | + tarball = download_setuptools(download_base=options.download_base) |
| 256 | + return _install(tarball, _build_install_args(options)) |
| 257 | + |
| 258 | +if __name__ == '__main__': |
| 259 | + sys.exit(main()) |
0 commit comments