Commit e601a323 authored by Jason R. Coombs's avatar Jason R. Coombs

Removed the bulk of the anti-setuptools logic in ez_setup.py

--HG--
branch : Setuptools-Distribute merge
extra : source : 68b6b7a23e9150de6f2cc6ea37e1233ddbf79b22
parent 31e60749
#!python #!python
"""Bootstrap distribute installation """Bootstrap setuptools installation
If you want to use setuptools in your package's setup.py, just include this If you want to use setuptools in your package's setup.py, just include this
file in the same directory with it, and add this to the top of your setup.py:: file in the same directory with it, and add this to the top of your setup.py::
from distribute_setup import use_setuptools from ez_setup import use_setuptools
use_setuptools() use_setuptools()
If you want to require a specific version of setuptools, set a download If you want to require a specific version of setuptools, set a download
...@@ -16,8 +16,6 @@ This file can also be run as a script to install or upgrade setuptools. ...@@ -16,8 +16,6 @@ This file can also be run as a script to install or upgrade setuptools.
import os import os
import shutil import shutil
import sys import sys
import time
import fnmatch
import tempfile import tempfile
import tarfile import tarfile
import optparse import optparse
...@@ -50,20 +48,7 @@ except ImportError: ...@@ -50,20 +48,7 @@ except ImportError:
return os.spawnl(os.P_WAIT, sys.executable, *args) == 0 return os.spawnl(os.P_WAIT, sys.executable, *args) == 0
DEFAULT_VERSION = "0.6.36" DEFAULT_VERSION = "0.6.36"
DEFAULT_URL = "http://pypi.python.org/packages/source/d/distribute/" DEFAULT_URL = "http://pypi.python.org/packages/source/s/setuptools/"
SETUPTOOLS_FAKED_VERSION = "0.6c11"
SETUPTOOLS_PKG_INFO = """\
Metadata-Version: 1.0
Name: setuptools
Version: %s
Summary: xxxx
Home-page: xxx
Author: xxx
Author-email: xxx
License: xxx
Description: xxx
""" % SETUPTOOLS_FAKED_VERSION
def _install(tarball, install_args=()): def _install(tarball, install_args=()):
...@@ -83,7 +68,7 @@ def _install(tarball, install_args=()): ...@@ -83,7 +68,7 @@ def _install(tarball, install_args=()):
log.warn('Now working in %s', subdir) log.warn('Now working in %s', subdir)
# installing # installing
log.warn('Installing Distribute') log.warn('Installing Setuptools')
if not _python_cmd('setup.py', 'install', *install_args): if not _python_cmd('setup.py', 'install', *install_args):
log.warn('Something went wrong during the installation.') log.warn('Something went wrong during the installation.')
log.warn('See the error message above.') log.warn('See the error message above.')
...@@ -111,7 +96,7 @@ def _build_egg(egg, tarball, to_dir): ...@@ -111,7 +96,7 @@ def _build_egg(egg, tarball, to_dir):
log.warn('Now working in %s', subdir) log.warn('Now working in %s', subdir)
# building an egg # building an egg
log.warn('Building a Distribute egg in %s', to_dir) log.warn('Building a Setuptools egg in %s', to_dir)
_python_cmd('setup.py', '-q', 'bdist_egg', '--dist-dir', to_dir) _python_cmd('setup.py', '-q', 'bdist_egg', '--dist-dir', to_dir)
finally: finally:
...@@ -124,7 +109,7 @@ def _build_egg(egg, tarball, to_dir): ...@@ -124,7 +109,7 @@ def _build_egg(egg, tarball, to_dir):
def _do_download(version, download_base, to_dir, download_delay): def _do_download(version, download_base, to_dir, download_delay):
egg = os.path.join(to_dir, 'distribute-%s-py%d.%d.egg' egg = os.path.join(to_dir, 'setuptools-%s-py%d.%d.egg'
% (version, sys.version_info[0], sys.version_info[1])) % (version, sys.version_info[0], sys.version_info[1]))
if not os.path.exists(egg): if not os.path.exists(egg):
tarball = download_setuptools(version, download_base, tarball = download_setuptools(version, download_base,
...@@ -136,31 +121,26 @@ def _do_download(version, download_base, to_dir, download_delay): ...@@ -136,31 +121,26 @@ def _do_download(version, download_base, to_dir, download_delay):
def use_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL, def use_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL,
to_dir=os.curdir, download_delay=15, no_fake=True): to_dir=os.curdir, download_delay=15):
# making sure we use the absolute path # making sure we use the absolute path
to_dir = os.path.abspath(to_dir) to_dir = os.path.abspath(to_dir)
was_imported = 'pkg_resources' in sys.modules or \ was_imported = 'pkg_resources' in sys.modules or \
'setuptools' in sys.modules 'setuptools' in sys.modules
try:
try: try:
import pkg_resources import pkg_resources
if not hasattr(pkg_resources, '_distribute'):
if not no_fake:
_fake_setuptools()
raise ImportError
except ImportError: except ImportError:
return _do_download(version, download_base, to_dir, download_delay) return _do_download(version, download_base, to_dir, download_delay)
try: try:
pkg_resources.require("distribute>=" + version) pkg_resources.require("setuptools>=" + version)
return return
except pkg_resources.VersionConflict: except pkg_resources.VersionConflict:
e = sys.exc_info()[1] e = sys.exc_info()[1]
if was_imported: if was_imported:
sys.stderr.write( sys.stderr.write(
"The required version of distribute (>=%s) is not available,\n" "The required version of setuptools (>=%s) is not available,\n"
"and can't be installed while this script is running. Please\n" "and can't be installed while this script is running. Please\n"
"install a more recent version first, using\n" "install a more recent version first, using\n"
"'easy_install -U distribute'." "'easy_install -U setuptools'."
"\n\n(Currently using %r)\n" % (version, e.args[0])) "\n\n(Currently using %r)\n" % (version, e.args[0]))
sys.exit(2) sys.exit(2)
else: else:
...@@ -170,16 +150,13 @@ def use_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL, ...@@ -170,16 +150,13 @@ def use_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL,
except pkg_resources.DistributionNotFound: except pkg_resources.DistributionNotFound:
return _do_download(version, download_base, to_dir, return _do_download(version, download_base, to_dir,
download_delay) download_delay)
finally:
if not no_fake:
_create_fake_setuptools_pkg_info(to_dir)
def download_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL, def download_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL,
to_dir=os.curdir, delay=15): to_dir=os.curdir, delay=15):
"""Download distribute from a specified location and return its filename """Download setuptools from a specified location and return its filename
`version` should be a valid distribute version number that is available `version` should be a valid setuptools version number that is available
as an egg for download under the `download_base` URL (which should end as an egg for download under the `download_base` URL (which should end
with a '/'). `to_dir` is the directory where the egg will be downloaded. with a '/'). `to_dir` is the directory where the egg will be downloaded.
`delay` is the number of seconds to pause before an actual download `delay` is the number of seconds to pause before an actual download
...@@ -191,7 +168,7 @@ def download_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL, ...@@ -191,7 +168,7 @@ def download_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL,
from urllib.request import urlopen from urllib.request import urlopen
except ImportError: except ImportError:
from urllib2 import urlopen from urllib2 import urlopen
tgz_name = "distribute-%s.tar.gz" % version tgz_name = "setuptools-%s.tar.gz" % version
url = download_base + tgz_name url = download_base + tgz_name
saveto = os.path.join(to_dir, tgz_name) saveto = os.path.join(to_dir, tgz_name)
src = dst = None src = dst = None
...@@ -212,255 +189,6 @@ def download_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL, ...@@ -212,255 +189,6 @@ def download_setuptools(version=DEFAULT_VERSION, download_base=DEFAULT_URL,
return os.path.realpath(saveto) return os.path.realpath(saveto)
def _no_sandbox(function):
def __no_sandbox(*args, **kw):
try:
from setuptools.sandbox import DirectorySandbox
if not hasattr(DirectorySandbox, '_old'):
def violation(*args):
pass
DirectorySandbox._old = DirectorySandbox._violation
DirectorySandbox._violation = violation
patched = True
else:
patched = False
except ImportError:
patched = False
try:
return function(*args, **kw)
finally:
if patched:
DirectorySandbox._violation = DirectorySandbox._old
del DirectorySandbox._old
return __no_sandbox
def _patch_file(path, content):
"""Will backup the file then patch it"""
f = open(path)
existing_content = f.read()
f.close()
if existing_content == content:
# already patched
log.warn('Already patched.')
return False
log.warn('Patching...')
_rename_path(path)
f = open(path, 'w')
try:
f.write(content)
finally:
f.close()
return True
_patch_file = _no_sandbox(_patch_file)
def _same_content(path, content):
f = open(path)
existing_content = f.read()
f.close()
return existing_content == content
def _rename_path(path):
new_name = path + '.OLD.%s' % time.time()
log.warn('Renaming %s to %s', path, new_name)
os.rename(path, new_name)
return new_name
def _remove_flat_installation(placeholder):
if not os.path.isdir(placeholder):
log.warn('Unkown installation at %s', placeholder)
return False
found = False
for file in os.listdir(placeholder):
if fnmatch.fnmatch(file, 'setuptools*.egg-info'):
found = True
break
if not found:
log.warn('Could not locate setuptools*.egg-info')
return
log.warn('Moving elements out of the way...')
pkg_info = os.path.join(placeholder, file)
if os.path.isdir(pkg_info):
patched = _patch_egg_dir(pkg_info)
else:
patched = _patch_file(pkg_info, SETUPTOOLS_PKG_INFO)
if not patched:
log.warn('%s already patched.', pkg_info)
return False
# now let's move the files out of the way
for element in ('setuptools', 'pkg_resources.py', 'site.py'):
element = os.path.join(placeholder, element)
if os.path.exists(element):
_rename_path(element)
else:
log.warn('Could not find the %s element of the '
'Setuptools distribution', element)
return True
_remove_flat_installation = _no_sandbox(_remove_flat_installation)
def _after_install(dist):
log.warn('After install bootstrap.')
placeholder = dist.get_command_obj('install').install_purelib
_create_fake_setuptools_pkg_info(placeholder)
def _create_fake_setuptools_pkg_info(placeholder):
if not placeholder or not os.path.exists(placeholder):
log.warn('Could not find the install location')
return
pyver = '%s.%s' % (sys.version_info[0], sys.version_info[1])
setuptools_file = 'setuptools-%s-py%s.egg-info' % \
(SETUPTOOLS_FAKED_VERSION, pyver)
pkg_info = os.path.join(placeholder, setuptools_file)
if os.path.exists(pkg_info):
log.warn('%s already exists', pkg_info)
return
log.warn('Creating %s', pkg_info)
try:
f = open(pkg_info, 'w')
except EnvironmentError:
log.warn("Don't have permissions to write %s, skipping", pkg_info)
return
try:
f.write(SETUPTOOLS_PKG_INFO)
finally:
f.close()
pth_file = os.path.join(placeholder, 'setuptools.pth')
log.warn('Creating %s', pth_file)
f = open(pth_file, 'w')
try:
f.write(os.path.join(os.curdir, setuptools_file))
finally:
f.close()
_create_fake_setuptools_pkg_info = _no_sandbox(
_create_fake_setuptools_pkg_info
)
def _patch_egg_dir(path):
# let's check if it's already patched
pkg_info = os.path.join(path, 'EGG-INFO', 'PKG-INFO')
if os.path.exists(pkg_info):
if _same_content(pkg_info, SETUPTOOLS_PKG_INFO):
log.warn('%s already patched.', pkg_info)
return False
_rename_path(path)
os.mkdir(path)
os.mkdir(os.path.join(path, 'EGG-INFO'))
pkg_info = os.path.join(path, 'EGG-INFO', 'PKG-INFO')
f = open(pkg_info, 'w')
try:
f.write(SETUPTOOLS_PKG_INFO)
finally:
f.close()
return True
_patch_egg_dir = _no_sandbox(_patch_egg_dir)
def _before_install():
log.warn('Before install bootstrap.')
_fake_setuptools()
def _under_prefix(location):
if 'install' not in sys.argv:
return True
args = sys.argv[sys.argv.index('install') + 1:]
for index, arg in enumerate(args):
for option in ('--root', '--prefix'):
if arg.startswith('%s=' % option):
top_dir = arg.split('root=')[-1]
return location.startswith(top_dir)
elif arg == option:
if len(args) > index:
top_dir = args[index + 1]
return location.startswith(top_dir)
if arg == '--user' and USER_SITE is not None:
return location.startswith(USER_SITE)
return True
def _fake_setuptools():
log.warn('Scanning installed packages')
try:
import pkg_resources
except ImportError:
# we're cool
log.warn('Setuptools or Distribute does not seem to be installed.')
return
ws = pkg_resources.working_set
try:
setuptools_dist = ws.find(
pkg_resources.Requirement.parse('setuptools', replacement=False)
)
except TypeError:
# old distribute API
setuptools_dist = ws.find(
pkg_resources.Requirement.parse('setuptools')
)
if setuptools_dist is None:
log.warn('No setuptools distribution found')
return
# detecting if it was already faked
setuptools_location = setuptools_dist.location
log.warn('Setuptools installation detected at %s', setuptools_location)
# if --root or --preix was provided, and if
# setuptools is not located in them, we don't patch it
if not _under_prefix(setuptools_location):
log.warn('Not patching, --root or --prefix is installing Distribute'
' in another location')
return
# let's see if its an egg
if not setuptools_location.endswith('.egg'):
log.warn('Non-egg installation')
res = _remove_flat_installation(setuptools_location)
if not res:
return
else:
log.warn('Egg installation')
pkg_info = os.path.join(setuptools_location, 'EGG-INFO', 'PKG-INFO')
if (os.path.exists(pkg_info) and
_same_content(pkg_info, SETUPTOOLS_PKG_INFO)):
log.warn('Already patched.')
return
log.warn('Patching...')
# let's create a fake egg replacing setuptools one
res = _patch_egg_dir(setuptools_location)
if not res:
return
log.warn('Patching complete.')
_relaunch()
def _relaunch():
log.warn('Relaunching...')
# we have to relaunch the process
# pip marker to avoid a relaunch bug
_cmd1 = ['-c', 'install', '--single-version-externally-managed']
_cmd2 = ['-c', 'install', '--record']
if sys.argv[:3] == _cmd1 or sys.argv[:3] == _cmd2:
sys.argv[0] = 'setup.py'
args = [sys.executable] + sys.argv
sys.exit(subprocess.call(args))
def _extractall(self, path=".", members=None): def _extractall(self, path=".", members=None):
"""Extract all members from the archive to the current working """Extract all members from the archive to the current working
directory and set owner, modification time and permissions on directory and set owner, modification time and permissions on
...@@ -510,7 +238,7 @@ def _extractall(self, path=".", members=None): ...@@ -510,7 +238,7 @@ def _extractall(self, path=".", members=None):
def _build_install_args(options): def _build_install_args(options):
""" """
Build the arguments to 'python setup.py install' on the distribute package Build the arguments to 'python setup.py install' on the setuptools package
""" """
install_args = [] install_args = []
if options.user_install: if options.user_install:
...@@ -531,7 +259,7 @@ def _parse_args(): ...@@ -531,7 +259,7 @@ def _parse_args():
parser.add_option( parser.add_option(
'--download-base', dest='download_base', metavar="URL", '--download-base', dest='download_base', metavar="URL",
default=DEFAULT_URL, default=DEFAULT_URL,
help='alternative URL from where to download the distribute package') help='alternative URL from where to download the setuptools package')
options, args = parser.parse_args() options, args = parser.parse_args()
# positional arguments are ignored # positional arguments are ignored
return options return options
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment