← Back to branch summary

~launchpad-pqm/launchpad/devel

« back to all changes in this revision

Viewing changes to ez_setup.py

  • Committer: Gary Poster
  • Date: 2009-04-21 21:01:16 UTC
  • mto: (8329.1.1 buildout2)
  • mto: This revision was merged to the branch mainline in revision 8489.
  • Revision ID: gary.poster@canonical.com-20090421210116-18no9ed8exo6mgs4
checkpoint: this initial buildout variant has several parts working, including run, start, stop, and harness.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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.6c8"
 
18
DEFAULT_URL     = "http://pypi.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
    'setuptools-0.6c6-py2.3.egg': '35686b78116a668847237b69d549ec20',
 
43
    'setuptools-0.6c6-py2.4.egg': '3c56af57be3225019260a644430065ab',
 
44
    'setuptools-0.6c6-py2.5.egg': 'b2f8a7520709a5b34f80946de5f02f53',
 
45
    'setuptools-0.6c7-py2.3.egg': '209fdf9adc3a615e5115b725658e13e2',
 
46
    'setuptools-0.6c7-py2.4.egg': '5a8f954807d46a0fb67cf1f26c55a82e',
 
47
    'setuptools-0.6c7-py2.5.egg': '45d2ad28f9750e7434111fde831e8372',
 
48
    'setuptools-0.6c8-py2.3.egg': '50759d29b349db8cfd807ba8303f1902',
 
49
    'setuptools-0.6c8-py2.4.egg': 'cba38d74f7d483c06e9daa6070cce6de',
 
50
    'setuptools-0.6c8-py2.5.egg': '1721747ee329dc150590a58b3e1ac95b',
 
51
}
 
52
 
 
53
import sys, os
 
54
 
 
55
def _validate_md5(egg_name, data):
 
56
    if egg_name in md5_data:
 
57
        from md5 import md5
 
58
        digest = md5(data).hexdigest()
 
59
        if digest != md5_data[egg_name]:
 
60
            print >>sys.stderr, (
 
61
                "md5 validation of %s failed!  (Possible download problem?)"
 
62
                % egg_name
 
63
            )
 
64
            sys.exit(2)
 
65
    return data
 
66
 
 
67
 
 
68
def use_setuptools(
 
69
    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
 
70
    download_delay=15, min_version=None
 
71
):
 
72
    """Automatically find/download setuptools and make it available on sys.path
 
73
 
 
74
    `version` should be a valid setuptools version number that is available
 
75
    as an egg for download under the `download_base` URL (which should end with
 
76
    a '/').  `to_dir` is the directory where setuptools will be downloaded, if
 
77
    it is not already available.  If `download_delay` is specified, it should
 
78
    be the number of seconds that will be paused before initiating a download,
 
79
    should one be required.  If an older version of setuptools is installed,
 
80
    this routine will print a message to ``sys.stderr`` and raise SystemExit in
 
81
    an attempt to abort the calling script.
 
82
    """
 
83
    # Work around a hack in the ez_setup.py file from simplejson==1.7.3.
 
84
    if min_version:
 
85
        version = min_version
 
86
 
 
87
    was_imported = 'pkg_resources' in sys.modules or 'setuptools' in sys.modules
 
88
    def do_download():
 
89
        egg = download_setuptools(version, download_base, to_dir, download_delay)
 
90
        sys.path.insert(0, egg)
 
91
        import setuptools; setuptools.bootstrap_install_from = egg
 
92
    try:
 
93
        import pkg_resources
 
94
    except ImportError:
 
95
        return do_download()       
 
96
    try:
 
97
        pkg_resources.require("setuptools>="+version); return
 
98
    except pkg_resources.VersionConflict, e:
 
99
        if was_imported:
 
100
            print >>sys.stderr, (
 
101
            "The required version of setuptools (>=%s) is not available, and\n"
 
102
            "can't be installed while this script is running. Please install\n"
 
103
            " a more recent version first, using 'easy_install -U setuptools'."
 
104
            "\n\n(Currently using %r)"
 
105
            ) % (version, e.args[0])
 
106
            sys.exit(2)
 
107
        else:
 
108
            del pkg_resources, sys.modules['pkg_resources']    # reload ok
 
109
            return do_download()
 
110
    except pkg_resources.DistributionNotFound:
 
111
        return do_download()
 
112
 
 
113
def download_setuptools(
 
114
    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
 
115
    delay = 15
 
116
):
 
117
    """Download setuptools from a specified location and return its filename
 
118
 
 
119
    `version` should be a valid setuptools version number that is available
 
120
    as an egg for download under the `download_base` URL (which should end
 
121
    with a '/'). `to_dir` is the directory where the egg will be downloaded.
 
122
    `delay` is the number of seconds to pause before an actual download attempt.
 
123
    """
 
124
    import urllib2, shutil
 
125
    egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3])
 
126
    url = download_base + egg_name
 
127
    saveto = os.path.join(to_dir, egg_name)
 
128
    src = dst = None
 
129
    if not os.path.exists(saveto):  # Avoid repeated downloads
 
130
        try:
 
131
            from distutils import log
 
132
            if delay:
 
133
                log.warn("""
 
134
---------------------------------------------------------------------------
 
135
This script requires setuptools version %s to run (even to display
 
136
help).  I will attempt to download it for you (from
 
137
%s), but
 
138
you may need to enable firewall access for this script first.
 
139
I will start the download in %d seconds.
 
140
 
 
141
(Note: if this machine does not have network access, please obtain the file
 
142
 
 
143
   %s
 
144
 
 
145
and place it in this directory before rerunning this script.)
 
146
---------------------------------------------------------------------------""",
 
147
                    version, download_base, delay, url
 
148
                ); from time import sleep; sleep(delay)
 
149
            log.warn("Downloading %s", url)
 
150
            src = urllib2.urlopen(url)
 
151
            # Read/write all in one block, so we don't create a corrupt file
 
152
            # if the download is interrupted.
 
153
            data = _validate_md5(egg_name, src.read())
 
154
            dst = open(saveto,"wb"); dst.write(data)
 
155
        finally:
 
156
            if src: src.close()
 
157
            if dst: dst.close()
 
158
    return os.path.realpath(saveto)
 
159
 
 
160
def main(argv, version=DEFAULT_VERSION):
 
161
    """Install or upgrade setuptools and EasyInstall"""
 
162
    try:
 
163
        import setuptools
 
164
    except ImportError:
 
165
        egg = None
 
166
        try:
 
167
            egg = download_setuptools(version, delay=0)
 
168
            sys.path.insert(0,egg)
 
169
            from setuptools.command.easy_install import main
 
170
            return main(list(argv)+[egg])   # we're done here
 
171
        finally:
 
172
            if egg and os.path.exists(egg):
 
173
                os.unlink(egg)
 
174
    else:
 
175
        if setuptools.__version__ == '0.0.1':
 
176
            print >>sys.stderr, (
 
177
            "You have an obsolete version of setuptools installed.  Please\n"
 
178
            "remove it from your system entirely before rerunning this script."
 
179
            )
 
180
            sys.exit(2)
 
181
 
 
182
    req = "setuptools>="+version
 
183
    import pkg_resources
 
184
    try:
 
185
        pkg_resources.require(req)
 
186
    except pkg_resources.VersionConflict:
 
187
        try:
 
188
            from setuptools.command.easy_install import main
 
189
        except ImportError:
 
190
            from easy_install import main
 
191
        main(list(argv)+[download_setuptools(delay=0)])
 
192
        sys.exit(0) # try to force an exit
 
193
    else:
 
194
        if argv:
 
195
            from setuptools.command.easy_install import main
 
196
            main(argv)
 
197
        else:
 
198
            print "Setuptools version",version,"or greater has been installed."
 
199
            print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)'
 
200
 
 
201
def update_md5(filenames):
 
202
    """Update our built-in md5 registry"""
 
203
 
 
204
    import re
 
205
    from md5 import md5
 
206
 
 
207
    for name in filenames:
 
208
        base = os.path.basename(name)
 
209
        f = open(name,'rb')
 
210
        md5_data[base] = md5(f.read()).hexdigest()
 
211
        f.close()
 
212
 
 
213
    data = ["    %r: %r,\n" % it for it in md5_data.items()]
 
214
    data.sort()
 
215
    repl = "".join(data)
 
216
 
 
217
    import inspect
 
218
    srcfile = inspect.getsourcefile(sys.modules[__name__])
 
219
    f = open(srcfile, 'rb'); src = f.read(); f.close()
 
220
 
 
221
    match = re.search("\nmd5_data = {\n([^}]+)}", src)
 
222
    if not match:
 
223
        print >>sys.stderr, "Internal error!"
 
224
        sys.exit(2)
 
225
 
 
226
    src = src[:match.start(1)] + repl + src[match.end(1):]
 
227
    f = open(srcfile,'w')
 
228
    f.write(src)
 
229
    f.close()
 
230
 
 
231
 
 
232
if __name__=='__main__':
 
233
    if len(sys.argv)>2 and sys.argv[1]=='--md5update':
 
234
        update_md5(sys.argv[2:])
 
235
    else:
 
236
        main(sys.argv[1:])
 
237
 
 
238
 
 
239
 
 
240
 
 
241