Commit a2260797 authored by gary's avatar gary

merge gary-1.5.2 branch

git-svn-id: http://svn.zope.org/repos/main/zc.buildout/trunk@116197 62d5b8a3-27da-0310-9561-8e5933582275
parent 16cba99e
...@@ -4,7 +4,22 @@ Change History ...@@ -4,7 +4,22 @@ Change History
1.5.2 (unreleased) 1.5.2 (unreleased)
================== ==================
(no changes) - IMPORTANT: For better backwards compatibility with the pre-1.5 line,
this release has two big changes from 1.5.0 and 1.5.1.
- Buildout defaults to including site packages.
- Buildout loads recipes and extensions with the same constraints to
site-packages that it builds eggs, instead of never allowing access
to site-packages.
This means that the default configuration should better support
pre-existing use of system Python in recipes or builds.
- To make it easier to detect the fact that buildout has set the PYTHONPATH,
BUILDOUT_ORIGINAL_PYTHONPATH is always set in the environment, even if
PYTHONPATH was not originally set. BUILDOUT_ORIGINAL_PYTHONPATH will
be an empty string if PYTHONPATH was not set.
1.5.1 (2010-08-29) 1.5.1 (2010-08-29)
================== ==================
......
...@@ -44,8 +44,17 @@ This can work if you follow a couple of simple rules. ...@@ -44,8 +44,17 @@ This can work if you follow a couple of simple rules.
how to update a recipe. Note that you should generally only need to how to update a recipe. Note that you should generally only need to
update recipes that generate scripts. update recipes that generate scripts.
You can then use ``include-site-packages = false`` and
``exec-sitecustomize = false`` buildout options to eliminate access to
your Python's site packages and not execute its sitecustomize file, if
it exists, respectively.
Alternately, you can use the ``allowed-eggs-from-site-packages`` buildout
option as a glob-aware whitelist of eggs that may come from site-packages.
This value defaults to "*", accepting all eggs.
It's important to note that recipes not upgraded for zc.buildout 1.5.0 It's important to note that recipes not upgraded for zc.buildout 1.5.0
should continue to work--just not with a system Python. should continue to work--just without internal support for a system Python.
Using a system Python is inherently fragile. Using a clean, Using a system Python is inherently fragile. Using a clean,
freshly-installed Python without customization in site-packages is more freshly-installed Python without customization in site-packages is more
...@@ -58,7 +67,7 @@ for more discussion. ...@@ -58,7 +67,7 @@ for more discussion.
However, using a system Python can be very convenient, and the However, using a system Python can be very convenient, and the
zc.buildout code for this feature has been tested by many users already. zc.buildout code for this feature has been tested by many users already.
Moreover, it has automated tests to exercise the problems that have been Moreover, it has automated tests to exercise the problems that have been
encountered and fixed. encountered and fixed. Many people rely on it.
Recipes That Support a System Python Recipes That Support a System Python
==================================== ====================================
...@@ -184,10 +193,9 @@ You might even be able to adopt some of it by subclassing or delegating. ...@@ -184,10 +193,9 @@ You might even be able to adopt some of it by subclassing or delegating.
The Scripts class in that file is the closest to what you might be used The Scripts class in that file is the closest to what you might be used
to from zc.recipe.egg. to from zc.recipe.egg.
Important note for recipe authors: the code in recipes is *always run Important note for recipe authors: As of buildout 1.5.2, the code in
without access to the site-packages*. This is irrespective of the recipes is *always run with the access to the site-packages as
``include-site-packages`` option discussed elsewhere, which controls the configured in the buildout section*.
software being built, but not the environment in which Buildout itself runs.
virtualenv virtualenv
========== ==========
......
...@@ -60,7 +60,8 @@ clean_path = sys.path[:] ...@@ -60,7 +60,8 @@ clean_path = sys.path[:]
import site import site
sys.path[:] = clean_path sys.path[:] = clean_path
for k, v in sys.modules.items(): for k, v in sys.modules.items():
if (hasattr(v, '__path__') and if k in ('setuptools', 'pkg_resources') or (
hasattr(v, '__path__') and
len(v.__path__)==1 and len(v.__path__)==1 and
not os.path.exists(os.path.join(v.__path__[0],'__init__.py'))): not os.path.exists(os.path.join(v.__path__[0],'__init__.py'))):
# This is a namespace package. Remove it. # This is a namespace package. Remove it.
...@@ -169,6 +170,7 @@ except ImportError: ...@@ -169,6 +170,7 @@ except ImportError:
if options.use_distribute: if options.use_distribute:
setup_args['no_fake'] = True setup_args['no_fake'] = True
ez['use_setuptools'](**setup_args) ez['use_setuptools'](**setup_args)
if 'pkg_resources' in sys.modules:
reload(sys.modules['pkg_resources']) reload(sys.modules['pkg_resources'])
import pkg_resources import pkg_resources
# This does not (always?) update the default working set. We will # This does not (always?) update the default working set. We will
......
...@@ -65,8 +65,8 @@ customized site.py. ...@@ -65,8 +65,8 @@ customized site.py.
import os import os
path = sys.path[0] path = sys.path[0]
if os.environ.get('PYTHONPATH'): if os.environ.get('PYTHONPATH'):
os.environ['BUILDOUT_ORIGINAL_PYTHONPATH'] = os.environ['PYTHONPATH']
path = os.pathsep.join([path, os.environ['PYTHONPATH']]) path = os.pathsep.join([path, os.environ['PYTHONPATH']])
os.environ['BUILDOUT_ORIGINAL_PYTHONPATH'] = os.environ.get('PYTHONPATH', '')
os.environ['PYTHONPATH'] = path os.environ['PYTHONPATH'] = path
import site # imports custom buildout-generated site.py import site # imports custom buildout-generated site.py
<BLANKLINE> <BLANKLINE>
......
...@@ -119,11 +119,14 @@ _buildout_default_options = _annotate_section({ ...@@ -119,11 +119,14 @@ _buildout_default_options = _annotate_section({
'accept-buildout-test-releases': 'false', 'accept-buildout-test-releases': 'false',
'allow-hosts': '*', 'allow-hosts': '*',
'allow-picked-versions': 'true', 'allow-picked-versions': 'true',
'allowed-eggs-from-site-packages': '*',
'bin-directory': 'bin', 'bin-directory': 'bin',
'develop-eggs-directory': 'develop-eggs', 'develop-eggs-directory': 'develop-eggs',
'eggs-directory': 'eggs', 'eggs-directory': 'eggs',
'executable': sys.executable, 'executable': sys.executable,
'exec-sitecustomize': 'true',
'find-links': '', 'find-links': '',
'include-site-packages': 'true',
'install-from-cache': 'false', 'install-from-cache': 'false',
'installed': '.installed.cfg', 'installed': '.installed.cfg',
'log-format': '', 'log-format': '',
...@@ -290,6 +293,18 @@ class Buildout(UserDict.DictMixin): ...@@ -290,6 +293,18 @@ class Buildout(UserDict.DictMixin):
zc.buildout.easy_install.install_from_cache( zc.buildout.easy_install.install_from_cache(
options.get_bool('install-from-cache')) options.get_bool('install-from-cache'))
zc.buildout.easy_install.always_unzip(options.get_bool('unzip')) zc.buildout.easy_install.always_unzip(options.get_bool('unzip'))
allowed_eggs = tuple(name.strip() for name in options[
'allowed-eggs-from-site-packages'].split('\n'))
self.include_site_packages = options.get_bool('include-site-packages')
self.exec_sitecustomize = options.get_bool('exec-sitecustomize')
if (_sys_executable_has_broken_dash_S and
(not self.include_site_packages or allowed_eggs != ('*',))):
# We can't do this if the executable has a broken -S.
warnings.warn(zc.buildout.easy_install.BROKEN_DASH_S_WARNING)
self.include_site_packages = True
zc.buildout.easy_install.allowed_eggs_from_site_packages(allowed_eggs)
zc.buildout.easy_install.include_site_packages(
self.include_site_packages)
download_cache = options.get('download-cache') download_cache = options.get('download-cache')
if download_cache: if download_cache:
...@@ -337,7 +352,6 @@ class Buildout(UserDict.DictMixin): ...@@ -337,7 +352,6 @@ class Buildout(UserDict.DictMixin):
distributions, options['executable'], distributions, options['executable'],
[options['develop-eggs-directory'], [options['develop-eggs-directory'],
options['eggs-directory']], options['eggs-directory']],
include_site_packages=_sys_executable_has_broken_dash_S,
prefer_final=not self.accept_buildout_test_releases, prefer_final=not self.accept_buildout_test_releases,
) )
else: else:
...@@ -349,7 +363,6 @@ class Buildout(UserDict.DictMixin): ...@@ -349,7 +363,6 @@ class Buildout(UserDict.DictMixin):
path=[options['develop-eggs-directory']], path=[options['develop-eggs-directory']],
newest=self.newest, newest=self.newest,
allow_hosts=self._allow_hosts, allow_hosts=self._allow_hosts,
include_site_packages=_sys_executable_has_broken_dash_S,
prefer_final=not self.accept_buildout_test_releases, prefer_final=not self.accept_buildout_test_releases,
) )
...@@ -399,8 +412,10 @@ class Buildout(UserDict.DictMixin): ...@@ -399,8 +412,10 @@ class Buildout(UserDict.DictMixin):
zc.buildout.easy_install.sitepackage_safe_scripts( zc.buildout.easy_install.sitepackage_safe_scripts(
options['bin-directory'], ws, options['executable'], partsdir, options['bin-directory'], ws, options['executable'], partsdir,
reqs=['zc.buildout'], relative_paths=relative_paths, reqs=['zc.buildout'], relative_paths=relative_paths,
include_site_packages=_sys_executable_has_broken_dash_S, include_site_packages=self.include_site_packages,
script_initialization=script_initialization,) script_initialization=script_initialization,
exec_sitecustomize=self.exec_sitecustomize,
)
init = bootstrap init = bootstrap
...@@ -846,7 +861,6 @@ class Buildout(UserDict.DictMixin): ...@@ -846,7 +861,6 @@ class Buildout(UserDict.DictMixin):
index = options.get('index'), index = options.get('index'),
path = [options['develop-eggs-directory']], path = [options['develop-eggs-directory']],
allow_hosts = self._allow_hosts, allow_hosts = self._allow_hosts,
include_site_packages=_sys_executable_has_broken_dash_S,
prefer_final=not self.accept_buildout_test_releases, prefer_final=not self.accept_buildout_test_releases,
) )
...@@ -911,11 +925,20 @@ class Buildout(UserDict.DictMixin): ...@@ -911,11 +925,20 @@ class Buildout(UserDict.DictMixin):
script_initialization = _early_release_initialization_code script_initialization = _early_release_initialization_code
else: else:
script_initialization = '' script_initialization = ''
# (Honor the relative-paths option.)
relative_paths = options.get('relative-paths', 'false')
if relative_paths == 'true':
relative_paths = options['directory']
else:
assert relative_paths == 'false'
relative_paths = ''
zc.buildout.easy_install.sitepackage_safe_scripts( zc.buildout.easy_install.sitepackage_safe_scripts(
options['bin-directory'], ws, sys.executable, partsdir, options['bin-directory'], ws, options['executable'], partsdir,
reqs=['zc.buildout'], reqs=['zc.buildout'], relative_paths=relative_paths,
include_site_packages=_sys_executable_has_broken_dash_S, include_site_packages=self.include_site_packages,
script_initialization=script_initialization) script_initialization=script_initialization,
exec_sitecustomize=self.exec_sitecustomize,
)
# Restart # Restart
args = map(zc.buildout.easy_install._safe_arg, sys.argv) args = map(zc.buildout.easy_install._safe_arg, sys.argv)
...@@ -956,7 +979,6 @@ class Buildout(UserDict.DictMixin): ...@@ -956,7 +979,6 @@ class Buildout(UserDict.DictMixin):
links = self['buildout'].get('find-links', '').split(), links = self['buildout'].get('find-links', '').split(),
index = self['buildout'].get('index'), index = self['buildout'].get('index'),
newest=self.newest, allow_hosts=self._allow_hosts, newest=self.newest, allow_hosts=self._allow_hosts,
include_site_packages=_sys_executable_has_broken_dash_S,
prefer_final=not self.accept_buildout_test_releases) prefer_final=not self.accept_buildout_test_releases)
# Clear cache because extensions might now let us read pages we # Clear cache because extensions might now let us read pages we
...@@ -1072,7 +1094,6 @@ def _install_and_load(spec, group, entry, buildout): ...@@ -1072,7 +1094,6 @@ def _install_and_load(spec, group, entry, buildout):
working_set=pkg_resources.working_set, working_set=pkg_resources.working_set,
newest=buildout.newest, newest=buildout.newest,
allow_hosts=buildout._allow_hosts, allow_hosts=buildout._allow_hosts,
include_site_packages=_sys_executable_has_broken_dash_S,
prefer_final=not buildout.accept_buildout_test_releases) prefer_final=not buildout.accept_buildout_test_releases)
__doing__ = 'Loading %s recipe entry %s:%s.', group, spec, entry __doing__ = 'Loading %s recipe entry %s:%s.', group, spec, entry
......
...@@ -735,6 +735,8 @@ COMMAND_LINE_VALUE). ...@@ -735,6 +735,8 @@ COMMAND_LINE_VALUE).
DEFAULT_VALUE DEFAULT_VALUE
allow-picked-versions= true allow-picked-versions= true
DEFAULT_VALUE DEFAULT_VALUE
allowed-eggs-from-site-packages= *
DEFAULT_VALUE
bin-directory= bin bin-directory= bin
DEFAULT_VALUE DEFAULT_VALUE
develop= recipes develop= recipes
...@@ -745,10 +747,14 @@ COMMAND_LINE_VALUE). ...@@ -745,10 +747,14 @@ COMMAND_LINE_VALUE).
COMPUTED_VALUE COMPUTED_VALUE
eggs-directory= eggs eggs-directory= eggs
DEFAULT_VALUE DEFAULT_VALUE
exec-sitecustomize= true
DEFAULT_VALUE
executable= ... executable= ...
DEFAULT_VALUE DEFAULT_VALUE
find-links= find-links=
DEFAULT_VALUE DEFAULT_VALUE
include-site-packages= true
DEFAULT_VALUE
install-from-cache= false install-from-cache= false
DEFAULT_VALUE DEFAULT_VALUE
installed= .installed.cfg installed= .installed.cfg
...@@ -2232,12 +2238,15 @@ database is shown. ...@@ -2232,12 +2238,15 @@ database is shown.
accept-buildout-test-releases = false accept-buildout-test-releases = false
allow-hosts = * allow-hosts = *
allow-picked-versions = true allow-picked-versions = true
allowed-eggs-from-site-packages = *
bin-directory = /sample-buildout/bin bin-directory = /sample-buildout/bin
develop-eggs-directory = /sample-buildout/develop-eggs develop-eggs-directory = /sample-buildout/develop-eggs
directory = /sample-buildout directory = /sample-buildout
eggs-directory = /sample-buildout/eggs eggs-directory = /sample-buildout/eggs
exec-sitecustomize = true
executable = python executable = python
find-links = find-links =
include-site-packages = true
install-from-cache = false install-from-cache = false
installed = /sample-buildout/.installed.cfg installed = /sample-buildout/.installed.cfg
log-format = log-format =
...@@ -2259,6 +2268,37 @@ All of these options can be overridden by configuration files or by ...@@ -2259,6 +2268,37 @@ All of these options can be overridden by configuration files or by
command-line assignments. We've discussed most of these options command-line assignments. We've discussed most of these options
already, but let's review them and touch on some we haven't discussed: already, but let's review them and touch on some we haven't discussed:
allowed-eggs-from-site-packages
Sometimes you need or want to control what eggs from site-packages are
used. The allowed-eggs-from-site-packages option allows you to specify a
whitelist of project names that may be included from site-packages. You
can use globs to specify the value. It defaults to a single value of '*',
indicating that any package may come from site-packages.
Here's a usage example::
[buildout]
...
allowed-eggs-from-site-packages =
demo
bigdemo
zope.*
This option interacts with the ``include-site-packages`` option in the
following ways.
If ``include-site-packages`` is true, then
``allowed-eggs-from-site-packages`` filters what eggs from site-packages
may be chosen. Therefore, if ``allowed-eggs-from-site-packages`` is an
empty list, then no eggs from site-packages are chosen, but site-packages
will still be included at the end of path lists.
If ``include-site-packages`` is false, the value of
``allowed-eggs-from-site-packages`` is irrelevant.
See the ``include-site-packages`` description for more information.
bin-directory bin-directory
The directory path where scripts are written. This can be a The directory path where scripts are written. This can be a
relative path, which is interpreted relative to the directory relative path, which is interpreted relative to the directory
...@@ -2279,10 +2319,27 @@ eggs-directory ...@@ -2279,10 +2319,27 @@ eggs-directory
*never* be modified. This can be a relative path, which is *never* be modified. This can be a relative path, which is
interpreted relative to the directory option. interpreted relative to the directory option.
exec-sitecustomize
Normally the Python's real sitecustomize module is processed.
If you do not want it to be processed in order to increase the
repeatability of your buildout, set this value to 'false'. This will
be honored irrespective of the setting for include-site-packages.
This option will be honored by some recipes and not others.
z3c.recipe.scripts honors this and zc.recipe.egg does not, for
instance.
executable executable
The Python executable used to run the buildout. See the python The Python executable used to run the buildout. See the python
option below. option below.
include-site-packages
You can choose not to have the site-packages of the underlying Python
available to your script or interpreter, in addition to the packages
from your eggs. This can increase repeatability for your buildout.
This option will be better used by some recipes than others.
z3c.recipe.scripts honors this fully and zc.recipe.egg only
partially, for instance.
installed installed
The file path where information about the results of the previous The file path where information about the results of the previous
buildout run is written. This can be a relative path, which is buildout run is written. This can be a relative path, which is
...@@ -2421,8 +2478,8 @@ If relative-paths is ``true``, the buildout script uses relative paths. ...@@ -2421,8 +2478,8 @@ If relative-paths is ``true``, the buildout script uses relative paths.
import os import os
path = sys.path[0] path = sys.path[0]
if os.environ.get('PYTHONPATH'): if os.environ.get('PYTHONPATH'):
os.environ['BUILDOUT_ORIGINAL_PYTHONPATH'] = os.environ['PYTHONPATH']
path = os.pathsep.join([path, os.environ['PYTHONPATH']]) path = os.pathsep.join([path, os.environ['PYTHONPATH']])
os.environ['BUILDOUT_ORIGINAL_PYTHONPATH'] = os.environ.get('PYTHONPATH', '')
os.environ['PYTHONPATH'] = path os.environ['PYTHONPATH'] = path
import site # imports custom buildout-generated site.py import site # imports custom buildout-generated site.py
<BLANKLINE> <BLANKLINE>
......
...@@ -1287,8 +1287,8 @@ _script_initialization_template = ''' ...@@ -1287,8 +1287,8 @@ _script_initialization_template = '''
import os import os
path = sys.path[0] path = sys.path[0]
if os.environ.get('PYTHONPATH'): if os.environ.get('PYTHONPATH'):
os.environ['BUILDOUT_ORIGINAL_PYTHONPATH'] = os.environ['PYTHONPATH']
path = os.pathsep.join([path, os.environ['PYTHONPATH']]) path = os.pathsep.join([path, os.environ['PYTHONPATH']])
os.environ['BUILDOUT_ORIGINAL_PYTHONPATH'] = os.environ.get('PYTHONPATH', '')
os.environ['PYTHONPATH'] = path os.environ['PYTHONPATH'] = path
import site # imports custom buildout-generated site.py import site # imports custom buildout-generated site.py
%(script_initialization)s''' %(script_initialization)s'''
...@@ -1564,7 +1564,7 @@ if _interactive: ...@@ -1564,7 +1564,7 @@ if _interactive:
# These are used only by the newer ``sitepackage_safe_scripts`` function. # These are used only by the newer ``sitepackage_safe_scripts`` function.
def _get_module_file(executable, name): def _get_module_file(executable, name, silent=False):
"""Return a module's file path. """Return a module's file path.
- executable is a path to the desired Python executable. - executable is a path to the desired Python executable.
...@@ -1585,6 +1585,7 @@ def _get_module_file(executable, name): ...@@ -1585,6 +1585,7 @@ def _get_module_file(executable, name):
cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env) cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env)
stdout, stderr = _proc.communicate(); stdout, stderr = _proc.communicate();
if _proc.returncode: if _proc.returncode:
if not silent:
logger.info( logger.info(
'Could not find file for module %s:\n%s', name, stderr) 'Could not find file for module %s:\n%s', name, stderr)
return None return None
...@@ -1610,7 +1611,7 @@ def _generate_sitecustomize(dest, executable, initialization='', ...@@ -1610,7 +1611,7 @@ def _generate_sitecustomize(dest, executable, initialization='',
sitecustomize.write(initialization + '\n') sitecustomize.write(initialization + '\n')
if exec_sitecustomize: if exec_sitecustomize:
real_sitecustomize_path = _get_module_file( real_sitecustomize_path = _get_module_file(
executable, 'sitecustomize') executable, 'sitecustomize', silent=True)
if real_sitecustomize_path: if real_sitecustomize_path:
real_sitecustomize = open(real_sitecustomize_path, 'r') real_sitecustomize = open(real_sitecustomize_path, 'r')
sitecustomize.write( sitecustomize.write(
......
...@@ -1510,8 +1510,8 @@ The demo script runs the entry point defined in the demo egg: ...@@ -1510,8 +1510,8 @@ The demo script runs the entry point defined in the demo egg:
import os import os
path = sys.path[0] path = sys.path[0]
if os.environ.get('PYTHONPATH'): if os.environ.get('PYTHONPATH'):
os.environ['BUILDOUT_ORIGINAL_PYTHONPATH'] = os.environ['PYTHONPATH']
path = os.pathsep.join([path, os.environ['PYTHONPATH']]) path = os.pathsep.join([path, os.environ['PYTHONPATH']])
os.environ['BUILDOUT_ORIGINAL_PYTHONPATH'] = os.environ.get('PYTHONPATH', '')
os.environ['PYTHONPATH'] = path os.environ['PYTHONPATH'] = path
import site # imports custom buildout-generated site.py import site # imports custom buildout-generated site.py
<BLANKLINE> <BLANKLINE>
...@@ -1555,8 +1555,8 @@ Let's see ``script_arguments`` and ``script_initialization`` in action. ...@@ -1555,8 +1555,8 @@ Let's see ``script_arguments`` and ``script_initialization`` in action.
import os import os
path = sys.path[0] path = sys.path[0]
if os.environ.get('PYTHONPATH'): if os.environ.get('PYTHONPATH'):
os.environ['BUILDOUT_ORIGINAL_PYTHONPATH'] = os.environ['PYTHONPATH']
path = os.pathsep.join([path, os.environ['PYTHONPATH']]) path = os.pathsep.join([path, os.environ['PYTHONPATH']])
os.environ['BUILDOUT_ORIGINAL_PYTHONPATH'] = os.environ.get('PYTHONPATH', '')
os.environ['PYTHONPATH'] = path os.environ['PYTHONPATH'] = path
import site # imports custom buildout-generated site.py import site # imports custom buildout-generated site.py
import os import os
......
...@@ -320,6 +320,7 @@ def buildoutSetUp(test): ...@@ -320,6 +320,7 @@ def buildoutSetUp(test):
zc.buildout.easy_install.default_index_url = 'file://'+tmp zc.buildout.easy_install.default_index_url = 'file://'+tmp
os.environ['buildout-testing-index-url'] = ( os.environ['buildout-testing-index-url'] = (
zc.buildout.easy_install.default_index_url) zc.buildout.easy_install.default_index_url)
os.environ.pop('PYTHONPATH', None)
def tmpdir(name): def tmpdir(name):
path = os.path.join(base, name) path = os.path.join(base, name)
...@@ -365,6 +366,8 @@ def buildoutSetUp(test): ...@@ -365,6 +366,8 @@ def buildoutSetUp(test):
write('buildout.cfg', textwrap.dedent('''\ write('buildout.cfg', textwrap.dedent('''\
[buildout] [buildout]
parts = py parts = py
include-site-packages = false
exec-sitecustomize = false
[py] [py]
recipe = z3c.recipe.scripts recipe = z3c.recipe.scripts
......
...@@ -95,6 +95,10 @@ Our buildout script's site.py has been updated to use the new eggs: ...@@ -95,6 +95,10 @@ Our buildout script's site.py has been updated to use the new eggs:
"""Add site packages, as determined by zc.buildout. """Add site packages, as determined by zc.buildout.
<BLANKLINE> <BLANKLINE>
See original_addsitepackages, below, for the original version.""" See original_addsitepackages, below, for the original version."""
setuptools_path = '/sample-buildout/eggs/setuptools-99.99-pyN.N.egg'
sys.path.append(setuptools_path)
known_paths.add(os.path.normcase(setuptools_path))
import pkg_resources
buildout_paths = [ buildout_paths = [
'/sample-buildout/eggs/zc.buildout-99.99-pyN.N.egg', '/sample-buildout/eggs/zc.buildout-99.99-pyN.N.egg',
'/sample-buildout/eggs/setuptools-99.99-pyN.N.egg' '/sample-buildout/eggs/setuptools-99.99-pyN.N.egg'
...@@ -104,6 +108,14 @@ Our buildout script's site.py has been updated to use the new eggs: ...@@ -104,6 +108,14 @@ Our buildout script's site.py has been updated to use the new eggs:
if not sitedircase in known_paths and os.path.exists(sitedir): if not sitedircase in known_paths and os.path.exists(sitedir):
sys.path.append(sitedir) sys.path.append(sitedir)
known_paths.add(sitedircase) known_paths.add(sitedircase)
pkg_resources.working_set.add_entry(sitedir)
sys.__egginsert = len(buildout_paths) # Support setuptools.
original_paths = [
...
]
for path in original_paths:
if path == setuptools_path or path not in known_paths:
addsitedir(path, known_paths)
return known_paths return known_paths
... ...
......
...@@ -196,6 +196,7 @@ use local dev versions of zc.buildout and z3c.recipe.scripts. ...@@ -196,6 +196,7 @@ use local dev versions of zc.buildout and z3c.recipe.scripts.
... [buildout] ... [buildout]
... parts = eggs ... parts = eggs
... find-links = %(link_server)s ... find-links = %(link_server)s
... include-site-packages = false
... ...
... [primed_python] ... [primed_python]
... executable = %(py_path)s ... executable = %(py_path)s
...@@ -207,7 +208,7 @@ use local dev versions of zc.buildout and z3c.recipe.scripts. ...@@ -207,7 +208,7 @@ use local dev versions of zc.buildout and z3c.recipe.scripts.
... eggs = demo ... eggs = demo
... ''' % globals()) ... ''' % globals())
>>> print system(buildout) # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS >>> print system(buildout), # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS
Installing eggs. Installing eggs.
Getting distribution for 'demo'. Getting distribution for 'demo'.
Got demo 0.4c1. Got demo 0.4c1.
...@@ -226,20 +227,17 @@ use local dev versions of zc.buildout and z3c.recipe.scripts. ...@@ -226,20 +227,17 @@ use local dev versions of zc.buildout and z3c.recipe.scripts.
to the buildout script. Alternatively, use a Python executable with a to the buildout script. Alternatively, use a Python executable with a
working -S (such as a standard Python binary). working -S (such as a standard Python binary).
warnings.warn(BROKEN_DASH_S_WARNING) warnings.warn(BROKEN_DASH_S_WARNING)
<BLANKLINE>
So, it did what we asked as best it could, but gave a big warning. If So, it did what we asked as best it could, but gave a big warning. If
you don't want those warnings for those particular recipes that use the you don't want those warnings for those particular recipes that use the
new features, you can use the "-s" option to squelch the warnings. new features, you can use the "-s" option to squelch the warnings.
>>> print system(buildout + ' -s') >>> print system(buildout + ' -s'),
Updating eggs. Updating eggs.
<BLANKLINE>
A lower verbosity (one or more -q options) also quiets the warning. A lower verbosity (one or more -q options) also quiets the warning.
>>> print system(buildout + ' -q') >>> print system(buildout + ' -q'),
<BLANKLINE>
Notice that, as we saw before with bin/buildout, the generated scripts Notice that, as we saw before with bin/buildout, the generated scripts
are old-style, because the new-style feature gracefully degrades to the are old-style, because the new-style feature gracefully degrades to the
......
...@@ -37,7 +37,8 @@ include-site-packages ...@@ -37,7 +37,8 @@ include-site-packages
You can choose to have the site-packages of the underlying Python You can choose to have the site-packages of the underlying Python
available to your script or interpreter, in addition to the packages available to your script or interpreter, in addition to the packages
from your eggs. See the section on this option for motivations and from your eggs. See the section on this option for motivations and
warnings. warnings. As of zc.buildout 1.5.2, this defaults to true, for increased
backwards compatibility with pre 1.5 recipes and buildouts.
allowed-eggs-from-site-packages allowed-eggs-from-site-packages
Sometimes you need or want to control what eggs from site-packages are Sometimes you need or want to control what eggs from site-packages are
...@@ -153,6 +154,7 @@ You can also generate an interpreter alone with the ``interpreter`` recipe. ...@@ -153,6 +154,7 @@ You can also generate an interpreter alone with the ``interpreter`` recipe.
... """ ... """
... [buildout] ... [buildout]
... parts = py ... parts = py
... include-site-packages = false
... ...
... [py] ... [py]
... recipe = z3c.recipe.scripts:interpreter ... recipe = z3c.recipe.scripts:interpreter
...@@ -244,18 +246,19 @@ and the site_packages_path will be in the Python's path. ...@@ -244,18 +246,19 @@ and the site_packages_path will be in the Python's path.
>>> print site_packages_path >>> print site_packages_path
/executable_buildout/site-packages /executable_buildout/site-packages
Now let's take a look at include-site-packages. The default is false, Now let's take a look at include-site-packages.
so we will set it to true.
The default is value true (as of zc.buildout 1.5.2).
>>> write(sample_buildout, 'buildout.cfg', >>> write(sample_buildout, 'buildout.cfg',
... """ ... """
... [buildout] ... [buildout]
... parts = py ... parts = py
... executable = %(py_path)s ... executable = %(py_path)s
... exec-sitecustomize = false
... ...
... [py] ... [py]
... recipe = z3c.recipe.scripts:interpreter ... recipe = z3c.recipe.scripts:interpreter
... include-site-packages = true
... eggs = demo<0.3 ... eggs = demo<0.3
... find-links = %(server)s ... find-links = %(server)s
... index = %(server)s/index ... index = %(server)s/index
...@@ -280,6 +283,38 @@ Now executable_buildout/site-packages is included in sys.path. ...@@ -280,6 +283,38 @@ Now executable_buildout/site-packages is included in sys.path.
'/executable_buildout/site-packages'] '/executable_buildout/site-packages']
<BLANKLINE> <BLANKLINE>
If you set it to false, they are excluded.
>>> write(sample_buildout, 'buildout.cfg',
... """
... [buildout]
... parts = py
... executable = %(py_path)s
... exec-sitecustomize = false
...
... [py]
... recipe = z3c.recipe.scripts:interpreter
... include-site-packages = false
... eggs = demo<0.3
... find-links = %(server)s
... index = %(server)s/index
... """ % dict(server=link_server, py_path=py_path))
>>> print system(buildout),
Uninstalling py.
Installing py.
Generated interpreter '/sample-buildout/bin/py'.
>>> print system(join(sample_buildout, 'bin', 'py') +
... ''' -c "import sys, pprint; pprint.pprint(sys.path)"''')
... # doctest: +ELLIPSIS
['',
'/sample-buildout/parts/py',
...,
'/sample-buildout/eggs/demo-0.2-pyN.N.egg',
'/sample-buildout/eggs/demoneeded-1.2c1-pyN.N.egg']
<BLANKLINE>
As described above, the allowed-eggs-from-site-packages option lets us As described above, the allowed-eggs-from-site-packages option lets us
control what site-packages eggs zc.buildout will allow to fulfill control what site-packages eggs zc.buildout will allow to fulfill
dependencies. The behavior was described above with an example (and the dependencies. The behavior was described above with an example (and the
...@@ -320,7 +355,6 @@ document do not affect this example.) ...@@ -320,7 +355,6 @@ document do not affect this example.)
... ...
... [eggs] ... [eggs]
... recipe = z3c.recipe.scripts ... recipe = z3c.recipe.scripts
... include-site-packages = true
... python = primed_python ... python = primed_python
... eggs = demoneeded ... eggs = demoneeded
... ''' % globals()) ... ''' % globals())
...@@ -349,7 +383,6 @@ is not allowed to come from site-packages, and the buildout fails. ...@@ -349,7 +383,6 @@ is not allowed to come from site-packages, and the buildout fails.
... ...
... [eggs] ... [eggs]
... recipe = z3c.recipe.scripts ... recipe = z3c.recipe.scripts
... include-site-packages = true
... python = primed_python ... python = primed_python
... allowed-eggs-from-site-packages = ... allowed-eggs-from-site-packages =
... eggs = demoneeded ... eggs = demoneeded
...@@ -382,7 +415,6 @@ can be obtained from the buildout section if they are not set locally. ...@@ -382,7 +415,6 @@ can be obtained from the buildout section if they are not set locally.
... [buildout] ... [buildout]
... parts = eggs ... parts = eggs
... eggs-directory = tmpeggs ... eggs-directory = tmpeggs
... include-site-packages = true
... find-links = ... find-links =
... ...
... [primed_python] ... [primed_python]
...@@ -406,7 +438,6 @@ can be obtained from the buildout section if they are not set locally. ...@@ -406,7 +438,6 @@ can be obtained from the buildout section if they are not set locally.
... [buildout] ... [buildout]
... parts = eggs ... parts = eggs
... eggs-directory = tmpeggs ... eggs-directory = tmpeggs
... include-site-packages = true
... allowed-eggs-from-site-packages = ... allowed-eggs-from-site-packages =
... find-links = ... find-links =
... ...
...@@ -522,6 +553,7 @@ Let's look at the ``extends`` option first. ...@@ -522,6 +553,7 @@ Let's look at the ``extends`` option first.
... [demo] ... [demo]
... recipe = z3c.recipe.scripts ... recipe = z3c.recipe.scripts
... eggs = demo<0.3 ... eggs = demo<0.3
... include-site-packages = false
... find-links = %(server)s ... find-links = %(server)s
... index = %(server)s/index ... index = %(server)s/index
... initialization = ... initialization =
......
...@@ -209,6 +209,7 @@ paths into sys.path. ...@@ -209,6 +209,7 @@ paths into sys.path.
... recipe = z3c.recipe.scripts:interpreter ... recipe = z3c.recipe.scripts:interpreter
... find-links = %(server)s ... find-links = %(server)s
... index = %(server)s/index ... index = %(server)s/index
... include-site-packages = false
... relative-paths = true ... relative-paths = true
... extra-paths = ... extra-paths =
... /foo/bar ... /foo/bar
...@@ -245,10 +246,14 @@ can be used to fulfill direct and indirect dependencies of your package. If ...@@ -245,10 +246,14 @@ can be used to fulfill direct and indirect dependencies of your package. If
it did not, it might fail to exclude site-packages because one of the it did not, it might fail to exclude site-packages because one of the
dependencies actually was supposed to be fulfilled with it. dependencies actually was supposed to be fulfilled with it.
The default is ``include-site-packages = false``. This makes it possible to The default is ``include-site-packages = true``. This is backwards
easily use a system Python. As a demonstration, we will start with a compatible with previous versions of zc.buildout.
Python executable that has the "demoneeded" and "demo" eggs installed.
The eggs are not found. As a demonstration, we will start with a Python executable that has the
"demoneeded" and "demo" eggs installed. With the value of
include-site-packages to true in the default, the package will be found.
Notice we do not set find-links, but the eggs are still found because
they are in the executable's path.
>>> from zc.buildout.tests import create_sample_sys_install >>> from zc.buildout.tests import create_sample_sys_install
>>> py_path, site_packages_path = make_py() >>> py_path, site_packages_path = make_py()
...@@ -265,21 +270,16 @@ The eggs are not found. ...@@ -265,21 +270,16 @@ The eggs are not found.
... [eggs] ... [eggs]
... recipe = z3c.recipe.scripts ... recipe = z3c.recipe.scripts
... python = primed_python ... python = primed_python
... include-site-packages = true
... eggs = demoneeded ... eggs = demoneeded
... ''' % globals()) ... ''' % globals())
>>> print system(buildout)
Installing eggs. >>> print system(buildout),
Couldn't find index page for 'demoneeded' (maybe misspelled?)
Getting distribution for 'demoneeded'.
While:
Installing eggs. Installing eggs.
Getting distribution for 'demoneeded'.
Error: Couldn't find a distribution for 'demoneeded'.
<BLANKLINE>
However, if we set include-site-packages to true, the package will be found. You can set the value false explicitly. This makes it possible to
Notice we do not set find-links, but the eggs are still found because get a more repeatable build from a system Python. In our example, the
they are in the executable's path. eggs are not found, even though the system Python provides them.
>>> write('buildout.cfg', >>> write('buildout.cfg',
... ''' ... '''
...@@ -292,13 +292,19 @@ they are in the executable's path. ...@@ -292,13 +292,19 @@ they are in the executable's path.
... ...
... [eggs] ... [eggs]
... recipe = z3c.recipe.scripts ... recipe = z3c.recipe.scripts
... include-site-packages = false
... python = primed_python ... python = primed_python
... include-site-packages = true
... eggs = demoneeded ... eggs = demoneeded
... ''' % globals()) ... ''' % globals())
>>> print system(buildout) >>> print system(buildout)
Uninstalling eggs.
Installing eggs. Installing eggs.
Couldn't find index page for 'demoneeded' (maybe misspelled?)
Getting distribution for 'demoneeded'.
While:
Installing eggs.
Getting distribution for 'demoneeded'.
Error: Couldn't find a distribution for 'demoneeded'.
<BLANKLINE> <BLANKLINE>
We get an error if we specify anything but true or false: We get an error if we specify anything but true or false:
......
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