zfec/ez_setup.py

   1 #!python
   2 """Bootstrap setuptools installation
   3
   4 If you want to use setuptools in your package's setup.py, just include this
   5 file in the same directory with it, and add this to the top of your setup.py::
   6
   7     from ez_setup import use_setuptools
   8     use_setuptools()
   9
  10 If you want to require a specific version of setuptools, set a download
  11 mirror, or use an alternate download directory, you can do so by supplying
  12 the appropriate options to ``use_setuptools()``.
  13
  14 This file can also be run as a script to install or upgrade setuptools.
  15 """
  16 import sys
  17 DEFAULT_VERSION = "0.6c3"
  18 DEFAULT_URL     = "http://cheeseshop.python.org/packages/%s/s/setuptools/" % sys.version[:3]
  19
  20 md5_data = {
  21     'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca',
  22     'setuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb',
  23     'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b',
  24     'setuptools-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a',
  25     'setuptools-0.6b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618',
  26     'setuptools-0.6b3-py2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac',
  27     'setuptools-0.6b4-py2.3.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5',
  28     'setuptools-0.6b4-py2.4.egg': '4cb2a185d228dacffb2d17f103b3b1c4',
  29     'setuptools-0.6c1-py2.3.egg': 'b3f2b5539d65cb7f74ad79127f1a908c',
  30     'setuptools-0.6c1-py2.4.egg': 'b45adeda0667d2d2ffe14009364f2a4b',
  31     'setuptools-0.6c2-py2.3.egg': 'f0064bf6aa2b7d0f3ba0b43f20817c27',
  32     'setuptools-0.6c2-py2.4.egg': '616192eec35f47e8ea16cd6a122b7277',
  33     'setuptools-0.6c3-py2.3.egg': 'f181fa125dfe85a259c9cd6f1d7b78fa',
  34     'setuptools-0.6c3-py2.4.egg': 'e0ed74682c998bfb73bf803a50e7b71e',
  35     'setuptools-0.6c3-py2.5.egg': 'abef16fdd61955514841c7c6bd98965e',
  36     'setuptools-0.6c4-py2.3.egg': 'b0b9131acab32022bfac7f44c5d7971f',
  37     'setuptools-0.6c4-py2.4.egg': '2a1f9656d4fbf3c97bf946c0a124e6e2',
  38     'setuptools-0.6c4-py2.5.egg': '8f5a052e32cdb9c72bcf4b5526f28afc',
  39     'setuptools-0.6c5-py2.3.egg': 'ee9fd80965da04f2f3e6b3576e9d8167',
  40     'setuptools-0.6c5-py2.4.egg': 'afe2adf1c01701ee841761f5bcd8aa64',
  41     'setuptools-0.6c5-py2.5.egg': 'a8d3f61494ccaa8714dfed37bccd3d5d',
  42 }
  43
  44 import sys, os
  45
  46 def _validate_md5(egg_name, data):
  47     if egg_name in md5_data:
  48         from md5 import md5
  49         digest = md5(data).hexdigest()
  50         if digest != md5_data[egg_name]:
  51             print >>sys.stderr, (
  52                 "md5 validation of %s failed!  (Possible download problem?)"
  53                 % egg_name
  54             )
  55             sys.exit(2)
  56     return data
  57
  58
  59 def use_setuptools(
  60     version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
  61     download_delay=15
  62 ):
  63     """Automatically find/download setuptools and make it available on sys.path
  64
  65     `version` should be a valid setuptools version number that is available
  66     as an egg for download under the `download_base` URL (which should end with
  67     a '/').  `to_dir` is the directory where setuptools will be downloaded, if
  68     it is not already available.  If `download_delay` is specified, it should
  69     be the number of seconds that will be paused before initiating a download,
  70     should one be required.  If an older version of setuptools is installed,
  71     this routine will print a message to ``sys.stderr`` and raise SystemExit in
  72     an attempt to abort the calling script.
  73     """
  74     try:
  75         import setuptools
  76         if setuptools.__version__ == '0.0.1':
  77             print >>sys.stderr, (
  78             "You have an obsolete version of setuptools installed.  Please\n"
  79             "remove it from your system entirely before rerunning this script."
  80             )
  81             sys.exit(2)
  82     except ImportError:
  83         egg = download_setuptools(version, download_base, to_dir, download_delay)
  84         sys.path.insert(0, egg)
  85         import setuptools; setuptools.bootstrap_install_from = egg
  86
  87     import pkg_resources
  88     try:
  89         pkg_resources.require("setuptools>="+version)
  90
  91     except pkg_resources.VersionConflict, e:
  92         # XXX could we install in a subprocess here?
  93         print >>sys.stderr, (
  94             "The required version of setuptools (>=%s) is not available, and\n"
  95             "can't be installed while this script is running. Please install\n"
  96             " a more recent version first.\n\n(Currently using %r)"
  97         ) % (version, e.args[0])
  98         sys.exit(2)
  99
 100 def download_setuptools(
 101     version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir
 102 ):
 103     """Download setuptools from a specified location and return its filename
 104
 105     `version` should be a valid setuptools version number that is available
 106     as an egg for download under the `download_base` URL (which should end
 107     with a '/'). `to_dir` is the directory where the egg will be downloaded.
 108     `delay` is the number of seconds to pause before an actual download attempt.
 109     """
 110     import urllib2, shutil
 111     egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3])
 112     url = download_base + egg_name
 113     saveto = os.path.join(to_dir, egg_name)
 114     src = dst = None
 115     if not os.path.exists(saveto):  # Avoid repeated downloads
 116         try:
 117             from distutils import log
 118             if True:
 119                 log.warn("""
 120 ---------------------------------------------------------------------------
 121 This script requires setuptools version %s to run (even to display
 122 help).  I will attempt to download it for you (from
 123 %s), but
 124 you may need to enable firewall access for this script first.
 125
 126 (Note: if this machine does not have network access, please obtain the file
 127
 128    %s
 129
 130 and place it in this directory before rerunning this script.)
 131 ---------------------------------------------------------------------------""",
 132                     version, download_base, url
 133                 );
 134             log.warn("Downloading %s", url)
 135             src = urllib2.urlopen(url)
 136             # Read/write all in one block, so we don't create a corrupt file
 137             # if the download is interrupted.
 138             data = _validate_md5(egg_name, src.read())
 139             dst = open(saveto,"wb"); dst.write(data)
 140         finally:
 141             if src: src.close()
 142             if dst: dst.close()
 143     return os.path.realpath(saveto)
 144
 145 def main(argv, version=DEFAULT_VERSION):
 146     """Install or upgrade setuptools and EasyInstall"""
 147
 148     try:
 149         import setuptools
 150     except ImportError:
 151         egg = None
 152         try:
 153             egg = download_setuptools(version, delay=0)
 154             sys.path.insert(0,egg)
 155             from setuptools.command.easy_install import main
 156             return main(list(argv)+[egg])   # we're done here
 157         finally:
 158             if egg and os.path.exists(egg):
 159                 os.unlink(egg)
 160     else:
 161         if setuptools.__version__ == '0.0.1':
 162             # tell the user to uninstall obsolete version
 163             use_setuptools(version)
 164
 165     req = "setuptools>="+version
 166     import pkg_resources
 167     try:
 168         pkg_resources.require(req)
 169     except pkg_resources.VersionConflict:
 170         try:
 171             from setuptools.command.easy_install import main
 172         except ImportError:
 173             from easy_install import main
 174         main(list(argv)+[download_setuptools(delay=0)])
 175         sys.exit(0) # try to force an exit
 176     else:
 177         if argv:
 178             from setuptools.command.easy_install import main
 179             main(argv)
 180         else:
 181             print "Setuptools version",version,"or greater has been installed."
 182             print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)'
 183
 184
 185
 186 def update_md5(filenames):
 187     """Update our built-in md5 registry"""
 188
 189     import re
 190     from md5 import md5
 191
 192     for name in filenames:
 193         base = os.path.basename(name)
 194         f = open(name,'rb')
 195         md5_data[base] = md5(f.read()).hexdigest()
 196         f.close()
 197
 198     data = ["    %r: %r,\n" % it for it in md5_data.items()]
 199     data.sort()
 200     repl = "".join(data)
 201
 202     import inspect
 203     srcfile = inspect.getsourcefile(sys.modules[__name__])
 204     f = open(srcfile, 'rb'); src = f.read(); f.close()
 205
 206     match = re.search("\nmd5_data = {\n([^}]+)}", src)
 207     if not match:
 208         print >>sys.stderr, "Internal error!"
 209         sys.exit(2)
 210
 211     src = src[:match.start(1)] + repl + src[match.end(1):]
 212     f = open(srcfile,'w')
 213     f.write(src)
 214     f.close()
 215
 216
 217 if __name__=='__main__':
 218     if len(sys.argv)>2 and sys.argv[1]=='--md5update':
 219         update_md5(sys.argv[2:])
 220     else:
 221         main(sys.argv[1:])
 222
 223
 224
 225
 226