bootstrap-buildout.py 7.28 KB
Newer Older
André Anjos's avatar
André Anjos committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
##############################################################################
#
# Copyright (c) 2006 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Bootstrap a buildout-based project

Simply run this script in a directory containing a buildout.cfg.
The script accepts buildout command-line options, so you can
use the -c option to specify an alternate configuration file.
"""

import os
import shutil
import sys
import tempfile

from optparse import OptionParser

André Anjos's avatar
André Anjos committed
28 29 30 31
__version__ = '2015-07-01'
# See zc.buildout's changelog if this version is up to date.

tmpeggs = tempfile.mkdtemp(prefix='bootstrap-')
André Anjos's avatar
André Anjos committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45

usage = '''\
[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]

Bootstraps a buildout-based project.

Simply run this script in a directory containing a buildout.cfg, using the
Python that you want bin/buildout to use.

Note that by using --find-links to point to local resources, you can keep
this script from going over the network.
'''

parser = OptionParser(usage=usage)
André Anjos's avatar
André Anjos committed
46 47 48
parser.add_option("--version",
                  action="store_true", default=False,
                  help=("Return bootstrap.py version."))
André Anjos's avatar
André Anjos committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62
parser.add_option("-t", "--accept-buildout-test-releases",
                  dest='accept_buildout_test_releases',
                  action="store_true", default=False,
                  help=("Normally, if you do not specify a --version, the "
                        "bootstrap script and buildout gets the newest "
                        "*final* versions of zc.buildout and its recipes and "
                        "extensions for you.  If you use this flag, "
                        "bootstrap and buildout will get the newest releases "
                        "even if they are alphas or betas."))
parser.add_option("-c", "--config-file",
                  help=("Specify the path to the buildout configuration "
                        "file to be used."))
parser.add_option("-f", "--find-links",
                  help=("Specify a URL to search for buildout releases"))
Manuel Günther's avatar
Manuel Günther committed
63 64 65
parser.add_option("--allow-site-packages",
                  action="store_true", default=False,
                  help=("Let bootstrap.py use existing site packages"))
André Anjos's avatar
André Anjos committed
66 67
parser.add_option("--buildout-version",
                  help="Use a specific zc.buildout version")
Manuel Günther's avatar
Manuel Günther committed
68
parser.add_option("--setuptools-version",
André Anjos's avatar
André Anjos committed
69 70 71 72
                  help="Use a specific setuptools version")
parser.add_option("--setuptools-to-dir",
                  help=("Allow for re-use of existing directory of "
                        "setuptools versions"))
André Anjos's avatar
André Anjos committed
73 74

options, args = parser.parse_args()
André Anjos's avatar
André Anjos committed
75 76 77 78
if options.version:
    print("bootstrap.py version %s" % __version__)
    sys.exit(0)

André Anjos's avatar
André Anjos committed
79 80 81 82 83

######################################################################
# load/install setuptools

try:
Manuel Günther's avatar
Manuel Günther committed
84
    from urllib.request import urlopen
André Anjos's avatar
André Anjos committed
85
except ImportError:
Manuel Günther's avatar
Manuel Günther committed
86
    from urllib2 import urlopen
André Anjos's avatar
André Anjos committed
87

Manuel Günther's avatar
Manuel Günther committed
88
ez = {}
André Anjos's avatar
André Anjos committed
89 90 91 92
if os.path.exists('ez_setup.py'):
    exec(open('ez_setup.py').read(), ez)
else:
    exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez)
Manuel Günther's avatar
Manuel Günther committed
93 94 95 96 97 98 99 100 101 102

if not options.allow_site_packages:
    # ez_setup imports site, which adds site packages
    # this will remove them from the path to ensure that incompatible versions
    # of setuptools are not in the path
    import site
    # inside a virtualenv, there is no 'getsitepackages'.
    # We can't remove these reliably
    if hasattr(site, 'getsitepackages'):
        for sitepackage_path in site.getsitepackages():
André Anjos's avatar
André Anjos committed
103 104 105 106 107 108
            # Strip all site-packages directories from sys.path that
            # are not sys.prefix; this is because on Windows
            # sys.prefix is a site-package directory.
            if sitepackage_path != sys.prefix:
                sys.path[:] = [x for x in sys.path
                               if sitepackage_path not in x]
Manuel Günther's avatar
Manuel Günther committed
109 110 111 112 113

setup_args = dict(to_dir=tmpeggs, download_delay=0)

if options.setuptools_version is not None:
    setup_args['version'] = options.setuptools_version
André Anjos's avatar
André Anjos committed
114 115
if options.setuptools_to_dir is not None:
    setup_args['to_dir'] = options.setuptools_to_dir
Manuel Günther's avatar
Manuel Günther committed
116 117 118 119 120 121 122 123 124 125

ez['use_setuptools'](**setup_args)
import setuptools
import pkg_resources

# This does not (always?) update the default working set.  We will
# do it.
for path in sys.path:
    if path not in pkg_resources.working_set.entries:
        pkg_resources.working_set.add_entry(path)
André Anjos's avatar
André Anjos committed
126 127 128 129 130 131

######################################################################
# Install buildout

ws = pkg_resources.working_set

André Anjos's avatar
André Anjos committed
132 133 134 135
setuptools_path = ws.find(
    pkg_resources.Requirement.parse('setuptools')).location

# Fix sys.path here as easy_install.pth added before PYTHONPATH
André Anjos's avatar
André Anjos committed
136
cmd = [sys.executable, '-c',
André Anjos's avatar
André Anjos committed
137
       'import sys; sys.path[0:0] = [%r]; ' % setuptools_path +
André Anjos's avatar
André Anjos committed
138 139 140 141 142 143 144 145 146 147 148 149 150
       'from setuptools.command.easy_install import main; main()',
       '-mZqNxd', tmpeggs]

find_links = os.environ.get(
    'bootstrap-testing-find-links',
    options.find_links or
    ('http://downloads.buildout.org/'
     if options.accept_buildout_test_releases else None)
    )
if find_links:
    cmd.extend(['-f', find_links])

requirement = 'zc.buildout'
André Anjos's avatar
André Anjos committed
151
version = options.buildout_version
André Anjos's avatar
André Anjos committed
152 153 154 155 156 157
if version is None and not options.accept_buildout_test_releases:
    # Figure out the most recent final version of zc.buildout.
    import setuptools.package_index
    _final_parts = '*final-', '*final'

    def _final_version(parsed_version):
Manuel Günther's avatar
Manuel Günther committed
158 159 160 161 162 163 164 165 166
        try:
            return not parsed_version.is_prerelease
        except AttributeError:
            # Older setuptools
            for part in parsed_version:
                if (part[:1] == '*') and (part not in _final_parts):
                    return False
            return True

André Anjos's avatar
André Anjos committed
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
    index = setuptools.package_index.PackageIndex(
        search_path=[setuptools_path])
    if find_links:
        index.add_find_links((find_links,))
    req = pkg_resources.Requirement.parse(requirement)
    if index.obtain(req) is not None:
        best = []
        bestv = None
        for dist in index[req.project_name]:
            distv = dist.parsed_version
            if _final_version(distv):
                if bestv is None or distv > bestv:
                    best = [dist]
                    bestv = distv
                elif distv == bestv:
                    best.append(dist)
        if best:
            best.sort()
            version = best[-1].version
if version:
    requirement = '=='.join((requirement, version))
cmd.append(requirement)

import subprocess
André Anjos's avatar
André Anjos committed
191
if subprocess.call(cmd) != 0:
André Anjos's avatar
André Anjos committed
192
    raise Exception(
Manuel Günther's avatar
Manuel Günther committed
193
        "Failed to execute command:\n%s" % repr(cmd)[1:-1])
André Anjos's avatar
André Anjos committed
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210

######################################################################
# Import and run buildout

ws.add_entry(tmpeggs)
ws.require(requirement)
import zc.buildout.buildout

if not [a for a in args if '=' not in a]:
    args.append('bootstrap')

# if -c was provided, we push it back into args for buildout' main function
if options.config_file is not None:
    args[0:0] = ['-c', options.config_file]

zc.buildout.buildout.main(args)
shutil.rmtree(tmpeggs)