############################################################################## # # Copyright (c) 2005-2009 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. # ############################################################################## """Buildout main script """ from zc.buildout.rmtree import rmtree import zc.buildout.easy_install from functools import partial try: from hashlib import md5 as md5_original except ImportError: from md5 import md5 as md5_original try: from collections.abc import MutableMapping as DictMixin except ImportError: from UserDict import DictMixin try: from cStringIO import StringIO except ImportError: from io import StringIO try: from urllib.parse import urljoin except ImportError: from urlparse import urljoin import zc.buildout.configparser import copy import datetime import distutils.errors import errno import glob import importlib import inspect import itertools import logging import os import pkg_resources import re import shutil import subprocess import sys import tempfile import pprint import zc.buildout import zc.buildout.download from functools import partial PY3 = sys.version_info[0] == 3 if PY3: text_type = str else: text_type = unicode try: hashed = md5_original(b'test') md5 = md5_original except ValueError: md5 = partial(md5_original, usedforsecurity=False) def command(method): method.buildout_command = True return method def commands(cls): for name, method in cls.__dict__.items(): if hasattr(method, "buildout_command"): cls.COMMANDS.add(name) return cls def _print_options(sep=' ', end='\n', file=None): return sep, end, file def print_(*args, **kw): sep, end, file = _print_options(**kw) if file is None: file = sys.stdout file.write(sep.join(map(str, args))+end) _MARKER = [] class BuildoutSerialiser(object): # XXX: I would like to access pprint._safe_repr, but it's not # officially available. PrettyPrinter class has a functionally-speaking # static method "format" which just calls _safe_repr, but it is not # declared as static... So I must create an instance of it. _format = pprint.PrettyPrinter().format _dollar = '\\x%02x' % ord('$') _semicolon = '\\x%02x' % ord(';') _safe_globals = {'__builtins__': { # Types which are represented as calls to their constructor. 'bytearray': bytearray, 'complex': complex, 'frozenset': frozenset, 'set': set, # Those buildins are available through keywords, which allow creating # instances which in turn give back access to classes. So no point in # hiding them. 'dict': dict, 'list': list, 'str': str, 'tuple': tuple, 'False': False, 'True': True, 'None': None, }} def loads(self, value): return eval(value, self._safe_globals) def dumps(self, value): value, isreadable, _ = self._format(value, {}, 0, 0) if not isreadable: raise ValueError('Value cannot be serialised: %s' % (value, )) return value.replace('$', self._dollar).replace(';', self._semicolon) SERIALISED_VALUE_MAGIC = '!py' SERIALISED = re.compile(SERIALISED_VALUE_MAGIC + '([^!]*)!(.*)') SERIALISER_REGISTRY = { '': BuildoutSerialiser(), } SERIALISER_VERSION = '' SERIALISER = SERIALISER_REGISTRY[SERIALISER_VERSION] # Used only to compose data SERIALISER_PREFIX = SERIALISED_VALUE_MAGIC + SERIALISER_VERSION + '!' assert SERIALISED.match(SERIALISER_PREFIX).groups() == ( SERIALISER_VERSION, ''), SERIALISED.match(SERIALISER_PREFIX).groups() def dumps(value): orig_value = value value = SERIALISER.dumps(value) assert SERIALISER.loads(value) == orig_value, (repr(value), orig_value) return SERIALISER_PREFIX + value def loads(value): assert value.startswith(SERIALISED_VALUE_MAGIC), repr(value) version, data = SERIALISED.match(value).groups() return SERIALISER_REGISTRY[version].loads(data) realpath = zc.buildout.easy_install.realpath _isurl = re.compile('([a-zA-Z0-9+.-]+)://').match class MissingOption(zc.buildout.UserError, KeyError): """A required option was missing. """ class MissingSection(zc.buildout.UserError, KeyError): """A required section is missing. """ def __str__(self): return "The referenced section, %r, was not defined." % self.args[0] def _annotate_section(section, source): for key in section: section[key] = SectionKey(section[key], source) return section class SectionKey(object): def __init__(self, value, source): self.history = [] self.value = value self.addToHistory("SET", value, source) @property def source(self): return self.history[-1].source def overrideValue(self, sectionkey): self.value = sectionkey.value if sectionkey.history[-1].operation not in ['ADD', 'REMOVE']: self.addToHistory("OVERRIDE", sectionkey.value, sectionkey.source) else: self.history = copy.deepcopy(sectionkey.history) def setDirectory(self, value): self.value = value self.addToHistory("DIRECTORY", value, self.source) def addToValue(self, added, source): subvalues = self.value.split('\n') + added.split('\n') self.value = "\n".join(subvalues) self.addToHistory("ADD", added, source) def removeFromValue(self, removed, source): subvalues = [ v for v in self.value.split('\n') if v not in removed.split('\n') ] self.value = "\n".join(subvalues) self.addToHistory("REMOVE", removed, source) def addToHistory(self, operation, value, source): item = HistoryItem(operation, value, source) self.history.append(item) def printAll(self, key, basedir, verbose): self.printKeyAndValue(key) if verbose: self.printVerbose(basedir) else: self.printTerse(basedir) def printKeyAndValue(self, key): lines = self.value.splitlines() if len(lines) <= 1: args = [key, "="] if self.value: args.append(" ") args.append(self.value) print_(*args, sep='') else: print_(key, "= ", lines[0], sep='') for line in lines[1:]: print_(line) def printVerbose(self, basedir): print_() for item in reversed(self.history): item.printAll(basedir) print_() def printTerse(self, basedir): toprint = [] history = copy.deepcopy(self.history) while history: next = history.pop() if next.operation in ["ADD", "REMOVE"]: next.printShort(toprint, basedir) else: next.printShort(toprint, basedir) break for line in reversed(toprint): if line.strip(): print_(line) def __repr__(self): return "<SectionKey value=%s source=%s>" % ( " ".join(self.value.split('\n')), self.source) class HistoryItem(object): def __init__(self, operation, value, source): self.operation = operation self.value = value self.source = source def printShort(self, toprint, basedir): source = self.source_for_human(basedir) if self.operation in ["OVERRIDE", "SET", "DIRECTORY"]: toprint.append(" " + source) elif self.operation == "ADD": toprint.append("+= " + source) elif self.operation == "REMOVE": toprint.append("-= " + source) def printOperation(self): lines = self.value.splitlines() if len(lines) <= 1: print_(" ", self.operation, "VALUE =", self.value) else: print_(" ", self.operation, "VALUE =") for line in lines: print_(" ", " ", line) def printSource(self, basedir): if self.source in ( 'DEFAULT_VALUE', 'COMPUTED_VALUE', 'COMMAND_LINE_VALUE' ): prefix = "AS" else: prefix = "IN" print_(" ", prefix, self.source_for_human(basedir)) def source_for_human(self, basedir): if self.source.startswith(basedir): return os.path.relpath(self.source, basedir) else: return self.source def printAll(self, basedir): self.printSource(basedir) self.printOperation() def __repr__(self): return "<HistoryItem operation=%s value=%s source=%s>" % ( self.operation, " ".join(self.value.split('\n')), self.source) def _annotate(data, note): for key in data: data[key] = _annotate_section(data[key], note) return data def _print_annotate(data, verbose, chosen_sections, basedir): sections = list(data.keys()) sections.sort() print_() print_("Annotated sections") print_("="*len("Annotated sections")) for section in sections: if (not chosen_sections) or (section in chosen_sections): print_() print_('[%s]' % section) keys = list(data[section].keys()) keys.sort() for key in keys: sectionkey = data[section][key] sectionkey.printAll(key, basedir, verbose) def _remove_ignore_missing(path): try: os.remove(path) except OSError as e: if e.errno != errno.ENOENT: raise def _unannotate_section(section): for key in section: section[key] = section[key].value return section def _unannotate(data): for key in data: _unannotate_section(data[key]) return data def _format_picked_versions(picked_versions, required_by): output = ['[versions]'] required_output = [] for dist_, version in picked_versions: if dist_ in required_by: required_output.append('') required_output.append('# Required by:') for req_ in sorted(required_by[dist_]): required_output.append('# '+req_) target = required_output else: target = output target.append("%s = %s" % (dist_, version)) output.extend(required_output) return output _buildout_default_options = _annotate_section({ 'allow-hosts': '*', 'allow-picked-versions': 'true', 'bin-directory': 'bin', 'develop-eggs-directory': 'develop-eggs', 'eggs-directory': 'eggs', 'executable': sys.executable, 'find-links': '', 'install-from-cache': 'false', 'installed': '.installed.cfg', 'log-format': '', 'log-level': 'INFO', 'newest': 'true', 'offline': 'false', 'dry-run': 'false', 'check-signature': 'true', 'parts-directory': 'parts', 'prefer-final': 'true', 'python': 'buildout', 'show-picked-versions': 'false', 'socket-timeout': '', 'update-versions-file': '', 'use-dependency-links': 'true', 'allow-unknown-extras': 'false', }, 'DEFAULT_VALUE') def _get_user_config(): buildout_home = os.path.join(os.path.expanduser('~'), '.buildout') buildout_home = os.environ.get('BUILDOUT_HOME', buildout_home) return os.path.join(buildout_home, 'default.cfg') network_cache_parameter_dict = {} @commands class Buildout(DictMixin): COMMANDS = set() installed_part_options = None def __init__(self, config_file, cloptions, use_user_defaults=True, command=None, args=()): __doing__ = 'Initializing.' # default options _buildout_default_options_copy = copy.deepcopy( _buildout_default_options) data = dict(buildout=_buildout_default_options_copy) self._buildout_dir = os.getcwd() if config_file and not _isurl(config_file): config_file = os.path.abspath(config_file) if not os.path.exists(config_file): if command == 'init': self._init_config(config_file, args) elif command == 'setup': # Sigh. This model of a buildout instance # with methods is breaking down. :( config_file = None data['buildout']['directory'] = SectionKey( '.', 'COMPUTED_VALUE') else: raise zc.buildout.UserError( "Couldn't open %s" % config_file) elif command == 'init': raise zc.buildout.UserError( "%r already exists." % config_file) if config_file: data['buildout']['directory'] = SectionKey( os.path.dirname(config_file), 'COMPUTED_VALUE') result = {} for section, option, value in cloptions: result.setdefault(section, {})[option] = value options = result.setdefault('buildout', {}) extends = [] user_config = _get_user_config() if use_user_defaults and os.path.exists(user_config): extends.append(user_config) if config_file: extends.append(config_file) clextends = options.get('extends') if clextends: extends.append(clextends) options['extends'] = '\n'.join(extends) data = _extends(data, result, os.getcwd(), 'COMMAND_LINE_VALUE') # Set up versions section, if necessary if 'versions' not in data['buildout']: data['buildout']['versions'] = SectionKey( 'versions', 'DEFAULT_VALUE') if 'versions' not in data: data['versions'] = {} # Default versions: versions_section_name = data['buildout']['versions'].value if versions_section_name: versions = data[versions_section_name] else: versions = {} versions.update( dict((k, SectionKey(v, 'DEFAULT_VALUE')) for (k, v) in ( # Prevent downgrading due to prefer-final: ('zc.buildout', '>='+pkg_resources.working_set.find( pkg_resources.Requirement.parse('zc.buildout') ).version), # Use 2, even though not final ('zc.recipe.egg', '>=2.0.6'), ) if k not in versions )) # Absolutize some particular directory, handling also the ~/foo form, # and considering the location of the configuration file that generated # the setting as the base path, falling back to the main configuration # file location for name in ('download-cache', 'eggs-directory', 'extends-cache'): if name in data['buildout']: sectionkey = data['buildout'][name] origdir = sectionkey.value src = sectionkey.source if not origdir: del data['buildout'][name] continue if '${' in origdir: continue if not os.path.isabs(origdir): if src in ('DEFAULT_VALUE', 'COMPUTED_VALUE', 'COMMAND_LINE_VALUE'): if 'directory' in data['buildout']: basedir = data['buildout']['directory'].value else: basedir = self._buildout_dir else: if _isurl(src): raise zc.buildout.UserError( 'Setting "%s" to a non absolute location ("%s") ' 'within a\n' 'remote configuration file ("%s") is ambiguous.' % ( name, origdir, src)) basedir = os.path.dirname(src) absdir = os.path.expanduser(origdir) if not os.path.isabs(absdir): absdir = os.path.join(basedir, absdir) absdir = os.path.abspath(absdir) sectionkey.setDirectory(absdir) self._annotated = copy.deepcopy(data) self._raw = _unannotate(data) self._data = {} self._parts = [] self._initializing = [] self._signature_cache = {} self._default_requirement = None # provide some defaults before options are parsed # because while parsing options those attributes might be # used already (Gottfried Ganssauge) buildout_section = self._raw['buildout'] # Try to make sure we have absolute paths for standard # directories. We do this before doing substitutions, in case # a one of these gets read by another section. If any # variable references are used though, we leave it as is in # _buildout_path. if 'directory' in buildout_section: self._buildout_dir = buildout_section['directory'] for name in ('bin', 'parts', 'eggs', 'develop-eggs'): d = self._buildout_path(buildout_section[name+'-directory']) buildout_section[name+'-directory'] = d # Attributes on this buildout object shouldn't be used by # recipes in their __init__. It can cause bugs, because the # recipes will be instantiated below (``options = self['buildout']``) # before this has completed initializing. These attributes are # left behind for legacy support but recipe authors should # beware of using them. A better practice is for a recipe to # use the buildout['buildout'] options. links = buildout_section['find-links'] self._links = links and links.split() or () allow_hosts = buildout_section['allow-hosts'].split('\n') self._allow_hosts = tuple([host.strip() for host in allow_hosts if host.strip() != '']) self._logger = logging.getLogger('zc.buildout') self.offline = bool_option(buildout_section, 'offline') self.newest = ((not self.offline) and bool_option(buildout_section, 'newest') ) self.dry_run = (buildout_section['dry-run'] == 'true') self.check_signature = (buildout_section['check-signature'] == 'true') ################################################################## ## WARNING!!! ## ALL ATTRIBUTES MUST HAVE REASONABLE DEFAULTS AT THIS POINT ## OTHERWISE ATTRIBUTEERRORS MIGHT HAPPEN ANY TIME FROM RECIPES. ## RECIPES SHOULD GENERALLY USE buildout['buildout'] OPTIONS, NOT ## BUILDOUT ATTRIBUTES. ################################################################## # initialize some attrs and buildout directories. options = self['buildout'] # now reinitialize links = options.get('find-links', '') self._links = links and links.split() or () allow_hosts = options['allow-hosts'].split('\n') self._allow_hosts = tuple([host.strip() for host in allow_hosts if host.strip() != '']) self._buildout_dir = options['directory'] # Make sure we have absolute paths for standard directories. We do this # a second time here in case someone overrode these in their configs. for name in ('bin', 'parts', 'eggs', 'develop-eggs'): d = self._buildout_path(options[name+'-directory']) options[name+'-directory'] = d if options['installed']: options['installed'] = os.path.join(options['directory'], options['installed']) self._setup_logging() self._setup_socket_timeout() # finish w versions if versions_section_name: # refetching section name just to avoid a warning versions = self[versions_section_name] else: # remove annotations versions = dict((k, v.value) for (k, v) in versions.items()) options['versions'] # refetching section name just to avoid a warning self.versions = versions zc.buildout.easy_install.default_versions(versions) zc.buildout.easy_install.prefer_final( bool_option(options, 'prefer-final')) zc.buildout.easy_install.use_dependency_links( bool_option(options, 'use-dependency-links')) zc.buildout.easy_install.allow_picked_versions( bool_option(options, 'allow-picked-versions')) self.show_picked_versions = bool_option(options, 'show-picked-versions') self.update_versions_file = options['update-versions-file'] zc.buildout.easy_install.store_required_by(self.show_picked_versions or self.update_versions_file) download_cache = options.get('download-cache') extends_cache = options.get('extends-cache') if bool_option(options, 'abi-tag-eggs', 'false'): from zc.buildout.pep425tags import get_abi_tag options['eggs-directory'] = os.path.join( options['eggs-directory'], get_abi_tag()) eggs_cache = options.get('eggs-directory') for cache in [download_cache, extends_cache, eggs_cache]: if cache: cache = os.path.join(options['directory'], cache) if not os.path.exists(cache): self._logger.info('Creating directory %r.', cache) os.makedirs(cache) if download_cache: # Actually, we want to use a subdirectory in there called 'dist'. download_cache = os.path.join(download_cache, 'dist') if not os.path.exists(download_cache): os.mkdir(download_cache) zc.buildout.easy_install.download_cache(download_cache) if bool_option(options, 'install-from-cache'): if self.offline: raise zc.buildout.UserError( "install-from-cache can't be used with offline mode.\n" "Nothing is installed, even from cache, in offline\n" "mode, which might better be called 'no-install mode'.\n" ) zc.buildout.easy_install.install_from_cache(True) # "Use" each of the defaults so they aren't reported as unused options. for name in _buildout_default_options: options[name] os.chdir(options['directory']) networkcache_section_name = options.get('networkcache-section') if networkcache_section_name: networkcache_section = self[networkcache_section_name] for k in ( 'download-cache-url', 'download-dir-url', 'upload-cache-url', 'upload-dir-url', 'signature-certificate-list', 'signature-private-key-file', 'shacache-ca-file', 'shacache-cert-file', 'shacache-key-file', 'shadir-ca-file', 'shadir-cert-file', 'shadir-key-file', ): network_cache_parameter_dict[k] = networkcache_section.get(k, '') # parse signature list cert_marker = '-----BEGIN CERTIFICATE-----' network_cache_parameter_dict['signature-certificate-list'] = \ [cert_marker + '\n' + q.strip() \ for q in network_cache_parameter_dict['signature-certificate-list'].split(cert_marker) \ if q.strip()] def _buildout_path(self, name): if '${' in name: return name return os.path.join(self._buildout_dir, name) @command def bootstrap(self, args): __doing__ = 'Bootstrapping.' self._setup_directories() # Hack: propagate libnetworkcache soft dependency specs = ['zc.buildout'] try: import slapos.libnetworkcache specs.append('slapos.libnetworkcache') except ImportError: pass # Install buildout and dependent eggs following pinned versions. dest = self['buildout']['eggs-directory'] path = [self['buildout']['develop-eggs-directory']] if self.offline: # Cannot install: just check requirements are already met path.append(dest) dest = None ws = zc.buildout.easy_install.install( specs, dest, links=self._links, index=self['buildout'].get('index'), path=path, newest=self.newest, allow_hosts=self._allow_hosts, ) # If versions aren't pinned or if current modules match, # nothing will be installed, but then we'll copy them to # the local eggs or develop-eggs folder just after this. # Now copy buildout and setuptools eggs, and record destination eggs: entries = [] for dist in ws: if dist.precedence == pkg_resources.DEVELOP_DIST: dest = os.path.join(self['buildout']['develop-eggs-directory'], dist.key + '.egg-link') with open(dest, 'w') as fh: fh.write(dist.location) entries.append(dist.location) else: dest = os.path.join(self['buildout']['eggs-directory'], os.path.basename(dist.location)) entries.append(dest) if not os.path.exists(dest): if os.path.isdir(dist.location): shutil.copytree(dist.location, dest) else: shutil.copy2(dist.location, dest) # Create buildout script ws = pkg_resources.WorkingSet(entries) ws.require('zc.buildout') options = self['buildout'] eggs_dir = options['eggs-directory'] develop_eggs_dir = options['develop-eggs-directory'] ws = zc.buildout.easy_install.sort_working_set( ws, eggs_dir=eggs_dir, develop_eggs_dir=develop_eggs_dir ) zc.buildout.easy_install.scripts( ['zc.buildout'], ws, sys.executable, options['bin-directory'], relative_paths = ( bool_option(options, 'relative-paths', False) and options['directory'] or ''), ) def _init_config(self, config_file, args): print_('Creating %r.' % config_file) f = open(config_file, 'w') sep = re.compile(r'[\\/]') if args: eggs = '\n '.join(a for a in args if not sep.search(a)) sepsub = os.path.sep == '/' and '/' or re.escape(os.path.sep) paths = '\n '.join( sep.sub(sepsub, a) for a in args if sep.search(a)) f.write('[buildout]\n' 'parts = py\n' '\n' '[py]\n' 'recipe = zc.recipe.egg\n' 'interpreter = py\n' 'eggs =\n' ) if eggs: f.write(' %s\n' % eggs) if paths: f.write('extra-paths =\n %s\n' % paths) for p in [a for a in args if sep.search(a)]: if not os.path.exists(p): os.mkdir(p) else: f.write('[buildout]\nparts =\n') f.close() @command def init(self, args): self.bootstrap(()) if args: self.install(()) @command def install(self, install_args): try: self._install_parts(install_args) finally: if self.installed_part_options is not None: try: self._save_installed_options() finally: del self.installed_part_options if self.show_picked_versions or self.update_versions_file: self._print_picked_versions() self._unload_extensions() def _install_parts(self, install_args): __doing__ = 'Installing.' self._load_extensions() self._setup_directories() # Add develop-eggs directory to path so that it gets searched # for eggs: sys.path.insert(0, self['buildout']['develop-eggs-directory']) # Check for updates. This could cause the process to be restarted self._maybe_upgrade() # load installed data installed_part_options = self._read_installed_part_options() installed_parts = installed_part_options['buildout']['parts'].split() # Remove old develop eggs self._uninstall( installed_part_options['buildout'].get( 'installed_develop_eggs', '') ) # Build develop eggs installed_develop_eggs = self._develop() installed_part_options['buildout']['installed_develop_eggs' ] = installed_develop_eggs # From now, the caller will update the .installed.cfg at return. self.installed_part_options = installed_part_options install_parts = self['buildout']['parts'] if install_args: install_parts = install_args uninstall_missing = False else: install_parts = install_parts.split() uninstall_missing = True # load and initialize recipes [self[part]['recipe'] for part in install_parts] if not install_args: install_parts = self._parts if self._log_level < logging.DEBUG: sections = list(self) sections.sort() print_() print_('Configuration data:') for section in sorted(self._data): _save_options(section, self[section], sys.stdout) print_() del self._signature_cache # uninstall parts that are no-longer used or who's configs # have changed for part in reversed(installed_parts): if part in install_parts: old_options = installed_part_options[part].copy() installed_files = old_options.pop('__buildout_installed__') new_options = self.get(part).copy() if not self.check_signature: old_signature = old_options.get( '__buildout_signature__', None) new_signature = new_options.get( '__buildout_signature__', None) if old_signature != new_signature: self._logger.info( '[%s]: __buildout_signature__ is different ' 'but ignored.' % part) if new_signature: old_options['__buildout_signature__'] = new_signature else: del old_options['__buildout_signature__'] if old_options == new_options: # The options are the same, but are all of the # installed files still there? If not, we should # reinstall. if not installed_files: continue for f in installed_files.split('\n'): if not os.path.exists(self._buildout_path(f)): break else: continue # output debugging info if self._logger.getEffectiveLevel() < logging.DEBUG: for k in old_options: if k not in new_options: self._logger.debug("Part %s, dropped option %s.", part, k) elif old_options[k] != new_options[k]: self._logger.debug( "Part %s, option %s changed:\n%r != %r", part, k, new_options[k], old_options[k], ) for k in new_options: if k not in old_options: self._logger.debug("Part %s, new option %s.", part, k) elif not uninstall_missing: continue self._uninstall_part(part, installed_part_options) installed_parts = [p for p in installed_parts if p != part] installed_part_options['buildout']['parts'] = ( ' '.join(installed_parts)) # Check for unused buildout options: _check_for_unused_options_in_section(self, 'buildout') # install new parts all_installed_paths = {} for part in install_parts: signature = self[part].pop('__buildout_signature__') saved_options = self[part].copy() recipe = self[part].recipe if part in installed_parts: # update __doing__ = 'Updating %s.', part self._logger.info(*__doing__) if self.dry_run: continue old_options = installed_part_options[part] installed_files = old_options['__buildout_installed__'] try: update = recipe.update except AttributeError: update = recipe.install self._logger.warning( "The recipe for %s doesn't define an update " "method. Using its install method.", part) try: updated_files = self[part]._call(update) except Exception: installed_parts.remove(part) self._uninstall(installed_files) installed_part_options['buildout']['parts'] = ( ' '.join(installed_parts)) raise installed_files = set(installed_files.split('\n')) \ if installed_files else set() if updated_files: (installed_files.add if isinstance(updated_files, str) else installed_files.update)(updated_files) else: # install __doing__ = 'Installing %s.', part self._logger.info(*__doing__) if self.dry_run: continue installed_files = self[part]._call(recipe.install) if installed_files is None: self._logger.warning( "The %s install returned None. A path or " "iterable os paths should be returned.", part) elif installed_files: installed_files = ({installed_files} if isinstance(installed_files, str) else set(installed_files)) if installed_files: conflicts = installed_files.intersection( all_installed_paths) if conflicts: self._error( "The following paths are already" " installed by other sections: %r", {x: all_installed_paths[x] for x in conflicts}) all_installed_paths.update(dict.fromkeys(installed_files, part)) installed_files = '\n'.join(sorted(installed_files)) else: installed_files = '' saved_options['__buildout_installed__'] = installed_files saved_options['__buildout_signature__'] = signature installed_part_options[part] = saved_options if part not in installed_parts: installed_parts.append(part) installed_part_options['buildout']['parts'] = ( ' '.join(installed_parts)) _check_for_unused_options_in_section(self, part) if self._log_level < logging.INFO: self._save_installed_options() def _uninstall_part(self, part, installed_part_options): # uninstall part __doing__ = 'Uninstalling %s.', part self._logger.info(*__doing__) if self.dry_run: return # run uninstall recipe recipe, entry = _recipe(installed_part_options[part]) try: uninstaller = _install_and_load( recipe, 'zc.buildout.uninstall', entry, self) self._logger.info('Running uninstall recipe.') uninstaller(part, installed_part_options[part]) except (ImportError, pkg_resources.DistributionNotFound): pass # remove created files and directories self._uninstall( installed_part_options[part]['__buildout_installed__']) def _setup_directories(self): __doing__ = 'Setting up buildout directories' # Create buildout directories for name in ('bin', 'parts', 'develop-eggs'): d = self['buildout'][name+'-directory'] if not os.path.exists(d): self._logger.info('Creating directory %r.', d) os.mkdir(d) def _develop(self): """Install sources by running setup.py develop on them """ __doing__ = 'Processing directories listed in the develop option' develop = self['buildout'].get('develop') if not develop: return '' dest = self['buildout']['develop-eggs-directory'] old_files = os.listdir(dest) env = dict(os.environ, PYTHONPATH=zc.buildout.easy_install.setuptools_pythonpath) here = os.getcwd() try: try: for setup in develop.split(): setup = self._buildout_path(setup) files = glob.glob(setup) if not files: self._logger.warning("Couldn't develop %r (not found)", setup) else: files.sort() for setup in files: self._logger.info("Develop: %r", setup) __doing__ = 'Processing develop directory %r.', setup zc.buildout.easy_install.develop(setup, dest) except: # if we had an error, we need to roll back changes, by # removing any files we created. self._sanity_check_develop_eggs_files(dest, old_files) self._uninstall('\n'.join( [os.path.join(dest, f) for f in os.listdir(dest) if f not in old_files ])) raise else: self._sanity_check_develop_eggs_files(dest, old_files) return '\n'.join([os.path.join(dest, f) for f in os.listdir(dest) if f not in old_files ]) finally: os.chdir(here) def _sanity_check_develop_eggs_files(self, dest, old_files): for f in os.listdir(dest): if f in old_files: continue if not (os.path.isfile(os.path.join(dest, f)) and f.endswith('.egg-link')): self._logger.warning( "Unexpected entry, %r, in develop-eggs directory.", f) _compute_part_signatures = None # BBB: monkey-patched by slapos.rebootstrap def _read_installed_part_options(self): old = self['buildout']['installed'] if old and os.path.isfile(old): fp = open(old) sections = zc.buildout.configparser.parse(fp, old) fp.close() result = {} for section, options in sections.items(): for option, value in options.items(): if '%(' in value: for k, v in _spacey_defaults: value = value.replace(k, v) options[option] = value result[section] = self.Options(self, section, options) return result else: return {'buildout': self.Options(self, 'buildout', {'parts': ''})} def _uninstall(self, installed): for f in installed.split('\n'): if not f: continue f = self._buildout_path(f) if os.path.isdir(f): rmtree(f) elif os.path.isfile(f): try: os.remove(f) except OSError: if not ( sys.platform == 'win32' and (realpath(os.path.join(os.path.dirname(sys.argv[0]), 'buildout.exe')) == realpath(f) ) # Sigh. This is the executable used to run the buildout # and, of course, it's in use. Leave it. ): raise def _install(self, part): options = self[part] recipe, entry = _recipe(options) recipe_class = pkg_resources.load_entry_point( recipe, 'zc.buildout', entry) installed = recipe_class(self, part, options).install() if installed is None: installed = [] elif isinstance(installed, str): installed = [installed] base = self._buildout_path('') installed = [d.startswith(base) and d[len(base):] or d for d in installed] return ' '.join(installed) def _save_installed_options(self): if self.dry_run: return installed_path = self['buildout']['installed'] if not installed_path: return installed_part_options = self.installed_part_options buildout = installed_part_options['buildout'] installed_parts = buildout['parts'] if installed_parts or buildout['installed_develop_eggs']: new = StringIO() _save_options('buildout', buildout, new) for part in installed_parts.split(): new.write('\n') _save_options(part, installed_part_options[part], new) new = new.getvalue() try: with open(installed_path) as f: save = f.read(1+len(new)) != new except IOError as e: if e.errno != errno.ENOENT: raise save = True if save: installed_tmp = installed_path + ".tmp" try: with open(installed_tmp, "w") as f: f.write(new) f.flush() os.fsync(f.fileno()) os.rename(installed_tmp, installed_path) finally: _remove_ignore_missing(installed_tmp) else: _remove_ignore_missing(installed_path) def _error(self, message, *args): raise zc.buildout.UserError(message % args) def _setup_socket_timeout(self): timeout = self['buildout']['socket-timeout'] if timeout != '': try: timeout = int(timeout) import socket self._logger.info( 'Setting socket time out to %d seconds.', timeout) socket.setdefaulttimeout(timeout) except ValueError: self._logger.warning("Default socket timeout is used !\n" "Value in configuration is not numeric: [%s].\n", timeout) def _setup_logging(self): root_logger = logging.getLogger() self._logger = logging.getLogger('zc.buildout') handler = logging.StreamHandler(sys.stdout) log_format = self['buildout']['log-format'] if not log_format: # No format specified. Use different formatter for buildout # and other modules, showing logger name except for buildout log_format = '%(name)s: %(message)s' buildout_handler = logging.StreamHandler(sys.stdout) buildout_handler.setFormatter(logging.Formatter('%(message)s')) self._logger.propagate = False self._logger.addHandler(buildout_handler) handler.setFormatter(logging.Formatter(log_format)) root_logger.addHandler(handler) level = self['buildout']['log-level'] if level in ('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'): level = getattr(logging, level) else: try: level = int(level) except ValueError: self._error("Invalid logging level %s", level) verbosity = self['buildout'].get('verbosity', 0) try: verbosity = int(verbosity) except ValueError: self._error("Invalid verbosity %s", verbosity) level -= verbosity root_logger.setLevel(level) self._log_level = level def _maybe_upgrade(self): # See if buildout or setuptools need to be upgraded. # If they do, do the upgrade and restart the buildout process. __doing__ = 'Checking for upgrades.' if 'BUILDOUT_RESTART_AFTER_UPGRADE' in os.environ: return if not self.newest: return # Hack: propagate libnetworkcache soft dependency # XXX just zc.buildout should suffice, then iter over projects in ws specs = ['zc.buildout', 'setuptools', 'pip', 'wheel'] try: import slapos.libnetworkcache specs.append('slapos.libnetworkcache') except ImportError: pass ws = zc.buildout.easy_install.install( specs, self['buildout']['eggs-directory'], links = self['buildout'].get('find-links', '').split(), index = self['buildout'].get('index'), path = [self['buildout']['develop-eggs-directory']], allow_hosts = self._allow_hosts ) upgraded = [] for project in specs: req = pkg_resources.Requirement.parse(project) dist = ws.find(req) importlib.import_module(project) if not inspect.getfile(sys.modules[project]).startswith(dist.location): upgraded.append(dist) if not upgraded: return __doing__ = 'Upgrading.' should_run = realpath( os.path.join(os.path.abspath(self['buildout']['bin-directory']), 'buildout') ) if sys.platform == 'win32': should_run += '-script.py' if (realpath(os.path.abspath(sys.argv[0])) != should_run): self._logger.debug("Running %r.", realpath(sys.argv[0])) self._logger.debug("Local buildout is %r.", should_run) self._logger.warning("Not upgrading because not running a local " "buildout command.") return self._logger.info("Upgraded:\n %s;\nRestarting.", ",\n ".join([("%s version %s" % (dist.project_name, dist.version) ) for dist in upgraded ] ), ) # the new dist is different, so we've upgraded. # Update the scripts and return True options = self['buildout'] eggs_dir = options['eggs-directory'] develop_eggs_dir = options['develop-eggs-directory'] ws = zc.buildout.easy_install.sort_working_set( ws, eggs_dir=eggs_dir, develop_eggs_dir=develop_eggs_dir ) zc.buildout.easy_install.scripts( ['zc.buildout'], ws, sys.executable, options['bin-directory'], relative_paths = ( bool_option(options, 'relative-paths', False) and options['directory'] or ''), ) # Restart args = sys.argv[:] if not __debug__: args.insert(0, '-O') args.insert(0, sys.executable) env=dict(os.environ, BUILDOUT_RESTART_AFTER_UPGRADE='1') sys.exit(subprocess.call(args, env=env)) def _load_extensions(self): __doing__ = 'Loading extensions.' specs = self['buildout'].get('extensions', '').split() for superceded_extension in ['buildout-versions', 'buildout.dumppickedversions']: if superceded_extension in specs: msg = ("Buildout now includes 'buildout-versions' (and part " "of the older 'buildout.dumppickedversions').\n" "Remove the extension from your configuration and " "look at the 'show-picked-versions' option in " "buildout's documentation.") raise zc.buildout.UserError(msg) if specs: path = [self['buildout']['develop-eggs-directory']] if self.offline: dest = None path.append(self['buildout']['eggs-directory']) else: dest = self['buildout']['eggs-directory'] zc.buildout.easy_install.install( specs, dest, path=path, working_set=pkg_resources.working_set, links = self['buildout'].get('find-links', '').split(), index = self['buildout'].get('index'), newest=self.newest, allow_hosts=self._allow_hosts) # Clear cache because extensions might now let us read pages we # couldn't read before. zc.buildout.easy_install.clear_index_cache() for ep in pkg_resources.iter_entry_points('zc.buildout.extension'): ep.load()(self) def _unload_extensions(self): __doing__ = 'Unloading extensions.' specs = self['buildout'].get('extensions', '').split() if specs: for ep in pkg_resources.iter_entry_points( 'zc.buildout.unloadextension'): ep.load()(self) def _print_picked_versions(self): picked_versions, required_by = (zc.buildout.easy_install .get_picked_versions()) if not picked_versions: # Don't print empty output. return output = _format_picked_versions(picked_versions, required_by) if self.show_picked_versions: print_("Versions had to be automatically picked.") print_("The following part definition lists the versions picked:") print_('\n'.join(output)) if self.update_versions_file: # Write to the versions file. if os.path.exists(self.update_versions_file): output[:1] = [ '', '# Added by buildout at %s' % datetime.datetime.now() ] output.append('') f = open(self.update_versions_file, 'a') f.write(('\n'.join(output))) f.close() print_("Picked versions have been written to " + self.update_versions_file) @command def setup(self, args): if not args: raise zc.buildout.UserError( "The setup command requires the path to a setup script or \n" "directory containing a setup script, and its arguments." ) setup = args.pop(0) if os.path.isdir(setup): setup = os.path.join(setup, 'setup.py') self._logger.info("Running setup script %r.", setup) setup = os.path.abspath(setup) fd, tsetup = tempfile.mkstemp() try: os.write(fd, (zc.buildout.easy_install.runsetup_template % dict( setupdir=os.path.dirname(setup), setup=setup, __file__ = setup, )).encode()) args = [sys.executable, tsetup] + args zc.buildout.easy_install.call_subprocess(args) finally: os.close(fd) os.remove(tsetup) @command def runsetup(self, args): self.setup(args) @command def query(self, args=None): if args is None or len(args) != 1: _error('The query command requires a single argument.') option = args[0] option = option.split(':') if len(option) == 1: option = 'buildout', option[0] elif len(option) != 2: _error('Invalid option:', args[0]) section, option = option verbose = self['buildout'].get('verbosity', 0) != 0 if verbose: print_('${%s:%s}' % (section, option)) try: print_(self._raw[section][option]) except KeyError: if section in self._raw: _error('Key not found:', option) else: _error('Section not found:', section) @command def annotate(self, args=None): verbose = self['buildout'].get('verbosity', 0) != 0 section = None if args is None: sections = [] else: sections = args _print_annotate(self._annotated, verbose, sections, self._buildout_dir) def print_options(self, base_path=None): for section in sorted(self._data): if section == 'buildout' or section == self['buildout']['versions']: continue print_('['+section+']') for k, v in sorted(self._data[section].items()): if '\n' in v: v = '\n ' + v.replace('\n', '\n ') else: v = ' '+v if base_path: v = v.replace(os.getcwd(), base_path) print_("%s =%s" % (k, v)) def initialize(self, options, reqs, entry): recipe_class = _install_and_load(reqs, 'zc.buildout', entry, self) try: sig = self._signature_cache[reqs] except KeyError: req = pkg_resources.Requirement.parse(reqs) sig = self._signature_cache[reqs] = sorted(set( _dists_sig(pkg_resources.working_set.resolve([req])))) self._initializing.append((options, sig)) try: recipe = recipe_class(self, options.name, options) options['__buildout_signature__'] finally: del self._initializing[-1] return recipe def __getitem__(self, section): __doing__ = 'Getting section %s.', section try: options = self._data[section] except KeyError: try: data = self._raw[section] except KeyError: raise MissingSection(section) options = self.Options(self, section, data) self._data[section] = options options._initialize() if self._initializing: caller = self._initializing[-1][0] if 'buildout' != section and not ( section in caller.depends or # Do not only check the caller, # because of circular dependencies during substitutions. section in (x[0].name for x in self._initializing)): caller.depends.add(section) return options def __setitem__(self, name, data): if name in self._raw: raise KeyError("Section already exists", name) self._raw[name] = dict((k, str(v)) for (k, v) in data.items()) self[name] # Add to parts def parse(self, data): import textwrap sections = zc.buildout.configparser.parse( StringIO(textwrap.dedent(data)), '', _default_globals) for name in sections: if name in self._raw: raise KeyError("Section already exists", name) self._raw[name] = dict((k, str(v)) for (k, v) in sections[name].items()) for name in sections: self[name] # Add to parts def __delitem__(self, key): raise NotImplementedError('__delitem__') def keys(self): return list(self._raw.keys()) def __iter__(self): return iter(self._raw) def __len__(self): return len(self._raw) _install_and_load_cache = {} def _install_and_load(spec, group, entry, buildout): __doing__ = 'Loading recipe %r.', spec key = spec, group, entry try: return _install_and_load_cache[key] except KeyError: pass try: req = pkg_resources.Requirement.parse(spec) buildout_options = buildout['buildout'] if pkg_resources.working_set.find(req) is None: __doing__ = 'Installing recipe %s.', spec if buildout.offline: dest = None path = [buildout_options['develop-eggs-directory'], buildout_options['eggs-directory'], ] else: dest = buildout_options['eggs-directory'] path = [buildout_options['develop-eggs-directory']] zc.buildout.easy_install.install( [spec], dest, links=buildout._links, index=buildout_options.get('index'), path=path, working_set=pkg_resources.working_set, newest=buildout.newest, allow_hosts=buildout._allow_hosts ) __doing__ = 'Loading %s recipe entry %s:%s.', group, spec, entry result = _install_and_load_cache[key] = pkg_resources.load_entry_point( req.project_name, group, entry) return result except Exception: v = sys.exc_info()[1] buildout._logger.log( 1, "Couldn't load %s entry point %s\nfrom %s:\n%s.", group, entry, spec, v) raise class Options(DictMixin): def __init__(self, buildout, section, data): self.buildout = buildout self.name = section self._raw = data self._cooked = {} self._data = {} self.depends = set() def _initialize(self): name = self.name __doing__ = 'Initializing section %s.', name if '<' in self._raw: self._raw = self._do_extend_raw(name, self._raw, []) default = self.buildout._default_requirement # force substitutions for k, v in sorted(self._raw.items()): if '${' in v: self._dosub(k, v) if name == 'buildout': return # buildout section can never be a part for dname in self.get('<part-dependencies>', '').split(): # force use of dependencies in buildout: self.buildout[dname] if self.get('recipe'): if default: self.depends.add(default) self.recipe = self.buildout.initialize(self, *_recipe(self._data)) self.buildout._parts.append(name) m = md5() # _profile_base_location_ is ignored in signatures, so that two sections # at different URLs can have same signature _profile_base_location_ = self.get('_profile_base_location_') # access values through .get() instead of .items() to detect unused keys for key in sorted(self.keys()): if key == '_profile_base_location_': continue value = self._data.get(key, self._cooked.get(key, self._raw.get(key))) if _profile_base_location_: value = value.replace(_profile_base_location_, '${:_profile_base_location_}') m.update(('%r\0%r\0' % (key, value)).encode()) self.items_signature = '%s:%s' % (name, m.hexdigest()) def _do_extend_raw(self, name, data, doing): if name == 'buildout': return data if name in doing: raise zc.buildout.UserError("Infinite extending loop %r" % name) doing.append(name) try: to_do = data.get('<', None) if to_do is None: return data __doing__ = 'Loading input sections for %r', name result = {} for iname in to_do.split('\n'): iname = iname.strip() if not iname: continue raw = self.buildout._raw.get(iname) if raw is None: raise zc.buildout.UserError("No section named %r" % iname) result.update(self._do_extend_raw(iname, raw, doing)) _annotate_section(result, "") data = _annotate_section(copy.deepcopy(data), "") _update_section(result, data) _unannotate_section(result) result.pop('<', None) return result finally: assert doing.pop() == name def _dosub(self, option, v): __doing__ = 'Getting option %s:%s.', self.name, option seen = [(self.name, option)] v = '$$'.join([self._sub(s, seen, last=False) for s in v.split('$$')]) self._cooked[option] = v def get(self, *args, **kw): v = self._get(*args, **kw) if hasattr(v, 'startswith') and v.startswith(SERIALISED_VALUE_MAGIC): v = loads(v) return v def _get(self, option, default=None, seen=None, last=True): # TODO: raise instead of handling a default parameter, # so that get() never tries to deserialize a default value # (and then: move deserialization to __getitem__ # and make get() use __getitem__) try: if last: return self._data[option].replace('$${', '${') else: return self._data[option] except KeyError: pass v = self._cooked.get(option) if v is None: v = self._raw.get(option) if v is None: if option == '__buildout_signature__': buildout = self.buildout options, sig = buildout._initializing[-1] if options is self: self.depends = frozenset(self.depends) v = self._data[option] = ' '.join(sig + [ buildout[dependency].items_signature for dependency in sorted(self.depends)]) return v raise zc.buildout.UserError("premature access to " + option) return default __doing__ = 'Getting option %s:%s.', self.name, option if '${' in v: key = self.name, option if seen is None: seen = [key] elif key in seen: raise zc.buildout.UserError( "Circular reference in substitutions.\n" ) else: seen.append(key) v = '$$'.join([self._sub(s, seen, last=False) for s in v.split('$$')]) seen.pop() self._data[option] = v if last: return v.replace('$${', '${') else: return v _template_split = re.compile('([$]{[^}]*})').split _simple = re.compile('[-a-zA-Z0-9 ._]+$').match _valid = re.compile(r'\${[-a-zA-Z0-9 ._]*:[-a-zA-Z0-9 ._]+}$').match def _sub(self, template, seen, last=True): value = self._template_split(template) subs = [] for ref in value[1::2]: s = tuple(ref[2:-1].split(':')) if not self._valid(ref): if len(s) < 2: raise zc.buildout.UserError("The substitution, %s,\n" "doesn't contain a colon." % ref) if len(s) > 2: raise zc.buildout.UserError("The substitution, %s,\n" "has too many colons." % ref) if not self._simple(s[0]): raise zc.buildout.UserError( "The section name in substitution, %s,\n" "has invalid characters." % ref) if not self._simple(s[1]): raise zc.buildout.UserError( "The option name in substitution, %s,\n" "has invalid characters." % ref) section, option = s if not section: section = self.name options = self else: self.buildout._initializing.append((self,)) try: options = self.buildout[section] finally: del self.buildout._initializing[-1] v = options._get(option, None, seen, last=last) if v is None: if option == '_buildout_section_name_': v = self.name else: raise MissingOption("Referenced option does not exist:", section, option) subs.append(v) subs.append('') return ''.join([''.join(v) for v in zip(value[::2], subs)]) def __getitem__(self, key): v = self.get(key, _MARKER) if v is _MARKER: raise MissingOption("Missing option: %s:%s" % (self.name, key)) return v def __setitem__(self, option, value): if not re.match(zc.buildout.configparser.option_name_re + '$', option): raise zc.buildout.UserError("Invalid option name %r" % (option, )) if not isinstance(value, str): value = dumps(value) self._data[option] = value.replace('${', '$${') def __delitem__(self, key): if key in self._raw: del self._raw[key] if key in self._data: del self._data[key] if key in self._cooked: del self._cooked[key] elif key in self._data: del self._data[key] else: raise KeyError(key) def keys(self): raw = self._raw return list(self._raw) + [k for k in self._data if k not in raw] def __iter__(self): return iter(self.keys()) def __len__(self): return len(self.keys()) def copy(self): result = copy.deepcopy(self._raw) result.update(self._cooked) result.update(self._data) for key, value in result.items(): if value.startswith(SERIALISED_VALUE_MAGIC): result[key] = loads(value) return result def _call(self, f): buildout_directory = self.buildout['buildout']['directory'] self._created = [] try: try: os.chdir(buildout_directory) return f() except: for p in self._created: if os.path.isdir(p): rmtree(p) elif os.path.isfile(p): os.remove(p) else: self.buildout._logger.warning("Couldn't clean up %r.", p) raise finally: self._created = None os.chdir(buildout_directory) def created(self, *paths): try: self._created.extend(paths) except AttributeError: raise TypeError( "Attempt to register a created path while not installing", self.name) return self._created def barrier(self): """Set self as a default requirement for not-yet processed parts This method must be called if this part may alter the processing of other parts in any way, like modifying environment variables. In other words, it sets an implicit dependency for these parts. """ buildout = self.buildout if not buildout._initializing: raise zc.buildout.UserError( "Options.barrier() shall only be used during initialization") buildout._default_requirement = self.name def __repr__(self): return repr(dict(self)) def __eq__(self, other): try: return sorted(self.items()) == sorted(other.items()) except Exception: return super(Options, self).__eq__(other) Buildout.Options = Options _spacey_nl = re.compile('[ \t\r\f\v]*\n[ \t\r\f\v\n]*' '|' '^[ \t\r\f\v]+' '|' '[ \t\r\f\v]+$' ) _spacey_defaults = [ ('%(__buildout_space__)s', ' '), ('%(__buildout_space_n__)s', '\n'), ('%(__buildout_space_r__)s', '\r'), ('%(__buildout_space_f__)s', '\f'), ('%(__buildout_space_v__)s', '\v'), ] def _quote_spacey_nl(match): match = match.group(0).split('\n', 1) result = '\n\t'.join( [(s .replace(' ', '%(__buildout_space__)s') .replace('\r', '%(__buildout_space_r__)s') .replace('\f', '%(__buildout_space_f__)s') .replace('\v', '%(__buildout_space_v__)s') .replace('\n', '%(__buildout_space_n__)s') ) for s in match] ) return result def _save_option(option, value, f): if not isinstance(value, str): value = dumps(value) value = _spacey_nl.sub(_quote_spacey_nl, value) if value.startswith('\n\t'): value = '%(__buildout_space_n__)s' + value[2:] if value.endswith('\n\t'): value = value[:-2] + '%(__buildout_space_n__)s' print_(option, '=', value, file=f) def _save_options(section, options, f): print_('[%s]' % section, file=f) try: get_option = partial(options._get, last=False) except AttributeError: get_option = options.get for option in sorted(options): _save_option(option, get_option(option), f) def _default_globals(): """Return a mapping of default and precomputed expressions. These default expressions are convenience defaults available when eveluating section headers expressions. NB: this is wrapped in a function so that the computing of these expressions is lazy and done only if needed (ie if there is at least one section with an expression) because the computing of some of these expressions can be expensive. """ # partially derived or inspired from its.py # Copyright (c) 2012, Kenneth Reitz All rights reserved. # Redistribution and use in source and binary forms, with or without modification, # are permitted provided that the following conditions are met: # Redistributions of source code must retain the above copyright notice, this list # of conditions and the following disclaimer. Redistributions in binary form must # reproduce the above copyright notice, this list of conditions and the following # disclaimer in the documentation and/or other materials provided with the # distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND # CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A # PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, # OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING # IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY # OF SUCH DAMAGE. # default available modules, explicitly re-imported locally here on purpose import sys import os import platform import re globals_defs = {'sys': sys, 'os': os, 'platform': platform, 're': re,} # major python major_python_versions as python2 and python3 major_python_versions = tuple(map(str, platform.python_version_tuple())) globals_defs.update({'python2': major_python_versions[0] == '2', 'python3': major_python_versions[0] == '3'}) # minor python major_python_versions as python24, python25 ... python39 minor_python_versions = ('24', '25', '26', '27', '30', '31', '32', '33', '34', '35', '36', '37', '38', '39', '310', '311', '312', '313', '314', '315') for v in minor_python_versions: globals_defs['python' + v] = ''.join(major_python_versions[:2]) == v # interpreter type sys_version = sys.version.lower() pypy = 'pypy' in sys_version jython = 'java' in sys_version ironpython ='iron' in sys_version # assume CPython, if nothing else. cpython = not any((pypy, jython, ironpython,)) globals_defs.update({'cpython': cpython, 'pypy': pypy, 'jython': jython, 'ironpython': ironpython}) # operating system sys_platform = str(sys.platform).lower() globals_defs.update({'linux': 'linux' in sys_platform, 'windows': 'win32' in sys_platform, 'cygwin': 'cygwin' in sys_platform, 'solaris': 'sunos' in sys_platform, 'macosx': 'darwin' in sys_platform, 'posix': 'posix' in os.name.lower()}) #bits and endianness import struct void_ptr_size = struct.calcsize('P') * 8 globals_defs.update({'bits32': void_ptr_size == 32, 'bits64': void_ptr_size == 64, 'little_endian': sys.byteorder == 'little', 'big_endian': sys.byteorder == 'big'}) return globals_defs variable_template_split = re.compile('([$]{[^}]*})').split class _extends(object): def __new__(cls, defaults, *args): self = super(_extends, cls).__new__(cls) self.seen = set() self.processing = [] self.extends = [defaults] self._download_options = [] self.collect(*args) return self.merge() def merge(self): result = {} for d in self.extends: _update(result, d) return result def __getattr__(self, attr): if attr == 'download_options': # Compute processed options result_so_far = self.merge() self.extends[:] = [result_so_far] value = copy.deepcopy(result_so_far.get('buildout')) or {} # Update with currently-being-processed options for options in reversed(self._download_options): _update_section(value, options) value = _unannotate_section(value) setattr(self, attr, value) return value return self.__getattribute__(attr) def collect(self, result, base, filename): options = result.get('buildout', {}) extends = options.pop('extends', '') # Sanitize buildout options if 'extended-by' in options: raise zc.buildout.UserError( 'No-longer supported "extended-by" option found in %s.' % filename) # Find and expose _profile_base_location_ for section in result.values(): for value in section.values(): if '${:_profile_base_location_}' in value: section['_profile_base_location_'] = base break _annotate(result, filename) # Collect extends and unprocessed download options self.processing.append(filename) self._download_options.append(options) for fextends in extends.split(): self.open(base, fextends) self.extends.append(result) del self.processing[-1], self._download_options[-1] def open(self, base, filename): # Determine file location if _isurl(filename): download = True elif _isurl(base): download = True filename = urljoin(base + '/', filename) else: download = False filename = os.path.realpath( os.path.join(base, os.path.expanduser(filename))) # Detect repetitions and loops if filename in self.seen: if filename in self.processing: raise zc.buildout.UserError("circular extends: %s" % filename) return self.seen.add(filename) # Fetch file is_temp = False try: if download: download_options = self.download_options extends_cache = download_options.get('extends-cache') if extends_cache and variable_template_split(extends_cache)[1::2]: raise ValueError( "extends-cache '%s' may not contain ${section:variable} to expand." % extends_cache ) downloaded_filename, is_temp = zc.buildout.download.Download( download_options, cache=extends_cache, fallback=bool_option(download_options, 'newest'), hash_name=True)(filename) filename_for_logging = '%s (downloaded as %s)' % ( filename, downloaded_filename) base = filename[:filename.rfind('/')] else: downloaded_filename = filename_for_logging = filename base = os.path.dirname(filename) with open(downloaded_filename) as fp: result = zc.buildout.configparser.parse( fp, filename_for_logging, _default_globals) finally: if is_temp: os.remove(downloaded_filename) return self.collect(result, base, filename) ignore_directories = '.svn', 'CVS', '__pycache__', '.git' _dir_hashes = {} def _dir_hash(dir): dir_hash = _dir_hashes.get(dir, None) if dir_hash is not None: return dir_hash hash = md5() for (dirpath, dirnames, filenames) in os.walk(dir): dirnames[:] = sorted(n for n in dirnames if n not in ignore_directories) filenames[:] = sorted(f for f in filenames if (not (f.endswith('pyc') or f.endswith('pyo')) and os.path.exists(os.path.join(dirpath, f))) ) for_hash = ' '.join(dirnames + filenames) if isinstance(for_hash, text_type): for_hash = for_hash.encode() hash.update(for_hash) for name in filenames: path = os.path.join(dirpath, name) if name == 'entry_points.txt': f = open(path) # Entry points aren't written in stable order. :( try: sections = zc.buildout.configparser.parse(f, path) data = repr([(sname, sorted(sections[sname].items())) for sname in sorted(sections)]).encode('utf-8') except Exception: f.close() f = open(path, 'rb') data = f.read() else: f = open(path, 'rb') data = f.read() f.close() hash.update(data) _dir_hashes[dir] = dir_hash = hash.hexdigest() return dir_hash def _dists_sig(dists): seen = set() result = [] for dist in sorted(dists): if dist in seen: continue seen.add(dist) location = dist.location if (dist.precedence == pkg_resources.DEVELOP_DIST and location != zc.buildout.easy_install.python_lib): result.append(dist.project_name + '-' + _dir_hash(location)) else: result.append(dist.project_name + '-' + dist.version) return result def _update_section(s1, s2): # Base section 2 on section 1; key-value pairs in s2 override those in s1. # If there are += or -= operators in s2, process these to add or subtract # items (delimited by newlines) from the preexisting values. # Sort on key, then on + and - operators, so that KEY < KEY + < KEY -, to # process them in this order if several are defined in the same section. # Section s1 is modified in place. keysort = lambda x: (x[0].rstrip(' +'), x[0].endswith('+')) for k, v in sorted(s2.items(), key=keysort): if k.endswith('+'): key = k.rstrip(' +') value = s1.get(key, SectionKey("", "IMPLICIT_VALUE")) value.addToValue(v.value, v.source) s1[key] = value elif k.endswith('-'): key = k.rstrip(' -') value = s1.get(key, SectionKey("", "IMPLICIT_VALUE")) value.removeFromValue(v.value, v.source) s1[key] = value else: if k in s1: v1 = s1[k] v1.overrideValue(v) else: s1[k] = v return s1 def _update(d1, d2): for section in d2: if section in d1: _update_section(d1[section], d2[section]) else: d1[section] = d2[section] return d1 def _recipe(options): recipe = options['recipe'] if ':' in recipe: recipe, entry = recipe.split(':') else: entry = 'default' return recipe, entry def _doing(): _, v, tb = sys.exc_info() message = str(v) doing = [] while tb is not None: d = tb.tb_frame.f_locals.get('__doing__') if d: doing.append(d) tb = tb.tb_next if doing: sys.stderr.write('While:\n') for d in doing: if not isinstance(d, str): d = d[0] % d[1:] sys.stderr.write(' %s\n' % d) def _error(*message): sys.stderr.write('Error: ' + ' '.join(message) +'\n') sys.exit(1) _internal_error_template = """ An internal error occurred due to a bug in either zc.buildout or in a recipe being used: """ def _check_for_unused_options_in_section(buildout, section): options = buildout[section] unused = [option for option in sorted(options._raw) if option not in options._data] if unused: buildout._logger.warning( "Section `%s` contains unused option(s): %s.\n" "This may be an indication for either a typo in the option's name " "or a bug in the used recipe." % (section, ' '.join(map(repr, unused))) ) _usage = """\ Usage: buildout [options] [assignments] [command [command arguments]] Options: -c config_file Specify the path to the buildout configuration file to be used. This defaults to the file named "buildout.cfg" in the current working directory. -D Debug errors. If an error occurs, then the post-mortem debugger will be started. This is especially useful for debugging recipe problems. -h, --help Print this message and exit. -N Run in non-newest mode. This is equivalent to the assignment buildout:newest=false. With this setting, buildout will not seek new distributions if installed distributions satisfy it's requirements. -q Decrease the level of verbosity. This option can be used multiple times. -t socket_timeout Specify the socket timeout in seconds. -U Don't read user defaults. -v Increase the level of verbosity. This option can be used multiple times. --version Print buildout version number and exit. --dry-run Dry-run mode. With this setting, buildout will display what will be uninstalled and what will be installed without doing anything in reality. --skip-signature-check Ignore __buildout_signature__ difference in comparing with the previously installed state. Note that __buildout_signature__ is updated with new dependencies by using this option. Assignments are of the form: section:option=value and are used to provide configuration options that override those given in the configuration file. For example, to run the buildout in offline mode, use buildout:offline=true. Options and assignments can be interspersed. Commands: install Install the parts specified in the buildout configuration. This is the default command if no command is specified. bootstrap Create a new buildout in the current working directory, copying the buildout and setuptools eggs and, creating a basic directory structure and a buildout-local buildout script. init [requirements] Initialize a buildout, creating a minimal buildout.cfg file if it doesn't exist and then performing the same actions as for the bootstrap command. If requirements are supplied, then the generated configuration will include an interpreter script that requires them. This provides an easy way to quickly set up a buildout to experiment with some packages. setup script [setup command and options] Run a given setup script arranging that setuptools is in the script's path and and that it has been imported so that setuptools-provided commands (like bdist_egg) can be used even if the setup script doesn't import setuptools. The script can be given either as a script path or a path to a directory containing a setup.py script. annotate Display annotated sections. All sections are displayed, sorted alphabetically. For each section, all key-value pairs are displayed, sorted alphabetically, along with the origin of the value (file name or COMPUTED_VALUE, DEFAULT_VALUE, COMMAND_LINE_VALUE). query section:key Display value of given section key pair. """ def _help(): print_(_usage) sys.exit(0) def _version(): version = pkg_resources.working_set.find( pkg_resources.Requirement.parse('zc.buildout')).version print_("buildout version %s" % version) sys.exit(0) def main(args=None): if args is None: args = sys.argv[1:] config_file = 'buildout.cfg' verbosity = 0 options = [] use_user_defaults = True debug = False while args: if args[0][0] == '-': op = orig_op = args.pop(0) op = op[1:] while op and op[0] in 'vqhWUoOnNDA': if op[0] == 'v': verbosity += 10 elif op[0] == 'q': verbosity -= 10 elif op[0] == 'U': use_user_defaults = False elif op[0] == 'o': options.append(('buildout', 'offline', 'true')) elif op[0] == 'O': options.append(('buildout', 'offline', 'false')) elif op[0] == 'n': options.append(('buildout', 'newest', 'true')) elif op[0] == 'N': options.append(('buildout', 'newest', 'false')) elif op[0] == 'D': debug = True else: _help() op = op[1:] if op[:1] in ('c', 't'): op_ = op[:1] op = op[1:] if op_ == 'c': if op: config_file = op else: if args: config_file = args.pop(0) else: _error("No file name specified for option", orig_op) elif op_ == 't': try: timeout_string = args.pop(0) timeout = int(timeout_string) options.append( ('buildout', 'socket-timeout', timeout_string)) except IndexError: _error("No timeout value specified for option", orig_op) except ValueError: _error("Timeout value must be numeric", orig_op) elif orig_op == '--dry-run': options.append(('buildout', 'dry-run', 'true')) elif orig_op == '--skip-signature-check': options.append(('buildout', 'check-signature', 'false')) elif op: if orig_op == '--help': _help() elif orig_op == '--version': _version() else: _error("Invalid option", orig_op) elif '=' in args[0]: option, value = args.pop(0).split('=', 1) option = option.split(':') if len(option) == 1: option = 'buildout', option[0] elif len(option) != 2: _error('Invalid option:', option) section, option = option options.append((section.strip(), option.strip(), value.strip())) else: # We've run out of command-line options and option assignments # The rest should be commands, so we'll stop here break if verbosity: options.append(('buildout', 'verbosity', str(verbosity))) if args: command = args.pop(0) if command not in Buildout.COMMANDS: _error('invalid command:', command) else: command = 'install' try: try: buildout = Buildout(config_file, options, use_user_defaults, command, args) getattr(buildout, command)(args) except SystemExit: logging.shutdown() # Make sure we properly propagate an exit code from a restarted # buildout process. raise except Exception: v = sys.exc_info()[1] _doing() exc_info = sys.exc_info() import pdb, traceback if debug: traceback.print_exception(*exc_info) sys.stderr.write('\nStarting pdb:\n') pdb.post_mortem(exc_info[2]) else: if isinstance(v, (zc.buildout.UserError, distutils.errors.DistutilsError ) ): _error(str(v)) else: sys.stderr.write(_internal_error_template) traceback.print_exception(*exc_info) sys.exit(1) finally: logging.shutdown() if sys.version_info[:2] < (2, 4): def reversed(iterable): result = list(iterable); result.reverse() return result _bool_names = {'true': True, 'false': False, True: True, False: False} def bool_option(options, name, default=None): value = options.get(name, default) if value is None: raise KeyError(name) try: return _bool_names[value] except KeyError: raise zc.buildout.UserError( 'Invalid value for %r option: %r' % (name, value))