ez_setup.py 9.5 KB

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