From 22def01adf117d38dbe20c8f719fbd2f50fe5393 Mon Sep 17 00:00:00 2001 From: alalazo Date: Mon, 19 Jun 2017 14:16:18 +0200 Subject: mixins: implemented declarative syntax Implemented a declarative syntax for the additional behavior that can get attached to classes. Implemented a function to filter compiler wrappers that uses the mechanism above. --- lib/spack/spack/__init__.py | 4 +- lib/spack/spack/directives.py | 25 ++++--- lib/spack/spack/mixins.py | 163 ++++++++++++++++++++++++++++++++---------- lib/spack/spack/package.py | 6 +- 4 files changed, 144 insertions(+), 54 deletions(-) (limited to 'lib') diff --git a/lib/spack/spack/__init__.py b/lib/spack/spack/__init__.py index 83355ad28c..ee310c2c3a 100644 --- a/lib/spack/spack/__init__.py +++ b/lib/spack/spack/__init__.py @@ -214,8 +214,8 @@ __all__ += [ 'IntelPackage', ] -import spack.mixins as mixins -__all__ += ['mixins'] +from spack.mixins import filter_compiler_wrappers +__all__ += ['filter_compiler_wrappers'] from spack.version import Version, ver __all__ += ['Version', 'ver'] diff --git a/lib/spack/spack/directives.py b/lib/spack/spack/directives.py index df19e85d54..d26910f1d9 100644 --- a/lib/spack/spack/directives.py +++ b/lib/spack/spack/directives.py @@ -74,7 +74,7 @@ __all__ = [] reserved_names = ['patches'] -class DirectiveMetaMixin(type): +class DirectiveMeta(type): """Flushes the directives that were temporarily stored in the staging area into the package. """ @@ -107,12 +107,12 @@ class DirectiveMetaMixin(type): # Move things to be executed from module scope (where they # are collected first) to class scope - if DirectiveMetaMixin._directives_to_be_executed: + if DirectiveMeta._directives_to_be_executed: attr_dict['_directives_to_be_executed'].extend( - DirectiveMetaMixin._directives_to_be_executed) - DirectiveMetaMixin._directives_to_be_executed = [] + DirectiveMeta._directives_to_be_executed) + DirectiveMeta._directives_to_be_executed = [] - return super(DirectiveMetaMixin, mcs).__new__( + return super(DirectiveMeta, mcs).__new__( mcs, name, bases, attr_dict) def __init__(cls, name, bases, attr_dict): @@ -127,7 +127,7 @@ class DirectiveMetaMixin(type): # Ensure the presence of the dictionaries associated # with the directives - for d in DirectiveMetaMixin._directive_names: + for d in DirectiveMeta._directive_names: setattr(cls, d, {}) # Lazily execute directives @@ -136,9 +136,9 @@ class DirectiveMetaMixin(type): # Ignore any directives executed *within* top-level # directives by clearing out the queue they're appended to - DirectiveMetaMixin._directives_to_be_executed = [] + DirectiveMeta._directives_to_be_executed = [] - super(DirectiveMetaMixin, cls).__init__(name, bases, attr_dict) + super(DirectiveMeta, cls).__init__(name, bases, attr_dict) @staticmethod def directive(dicts=None): @@ -188,7 +188,7 @@ class DirectiveMetaMixin(type): message = "dicts arg must be list, tuple, or string. Found {0}" raise TypeError(message.format(type(dicts))) # Add the dictionary names if not already there - DirectiveMetaMixin._directive_names |= set(dicts) + DirectiveMeta._directive_names |= set(dicts) # This decorator just returns the directive functions def _decorator(decorated_function): @@ -202,7 +202,7 @@ class DirectiveMetaMixin(type): # This allows nested directive calls in packages. The # caller can return the directive if it should be queued. def remove_directives(arg): - directives = DirectiveMetaMixin._directives_to_be_executed + directives = DirectiveMeta._directives_to_be_executed if isinstance(arg, (list, tuple)): # Descend into args that are lists or tuples for a in arg: @@ -228,18 +228,17 @@ class DirectiveMetaMixin(type): if not isinstance(values, collections.Sequence): values = (values, ) - DirectiveMetaMixin._directives_to_be_executed.extend(values) + DirectiveMeta._directives_to_be_executed.extend(values) # wrapped function returns same result as original so # that we can nest directives return result - return _wrapper return _decorator -directive = DirectiveMetaMixin.directive +directive = DirectiveMeta.directive @directive('versions') diff --git a/lib/spack/spack/mixins.py b/lib/spack/spack/mixins.py index 0a354362ce..d757a963b3 100644 --- a/lib/spack/spack/mixins.py +++ b/lib/spack/spack/mixins.py @@ -22,63 +22,150 @@ # License along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ############################################################################## +"""This module contains additional behavior that can be attached to any given +package. +""" +import collections import os import llnl.util.filesystem +import llnl.util.tty as tty -class FilterCompilerWrappers(object): - """This mixin class registers a callback that filters a list of files - after installation and substitutes hardcoded paths pointing to the Spack - compiler wrappers with the corresponding 'real' compilers. +__all__ = [ + 'filter_compiler_wrappers' +] + + +class PackageMixinsMeta(type): + """This metaclass serves the purpose of implementing a declarative syntax + for package mixins. + + Mixins are implemented below in the form of a function. Each one of them + needs to register a callable that takes a single argument to be run + before or after a certain phase. This callable is basically a method that + gets implicitly attached to the package class by calling the mixin. """ - #: compiler wrappers to be filtered (needs to be overridden) - to_be_filtered_for_wrappers = [] + _methods_to_be_added = {} + _add_method_before = collections.defaultdict(list) + _add_method_after = collections.defaultdict(list) - #: phase after which the callback is invoked (default 'install') - filter_phase = 'install' + @staticmethod + def register_method_before(fn, phase): + """Registers a method to be run before a certain phase. - def __init__(self): + Args: + fn: function taking a single argument (self) + phase (str): phase before which fn must run + """ + PackageMixinsMeta._methods_to_be_added[fn.__name__] = fn + PackageMixinsMeta._add_method_before[phase].append(fn) + + @staticmethod + def register_method_after(fn, phase): + """Registers a method to be run after a certain phase. + + Args: + fn: function taking a single argument (self) + phase (str): phase after which fn must run + """ + PackageMixinsMeta._methods_to_be_added[fn.__name__] = fn + PackageMixinsMeta._add_method_after[phase].append(fn) - attr_name = '_InstallPhase_{0}'.format(self.filter_phase) + def __init__(cls, name, bases, attr_dict): - # Here we want to get the attribute directly from the class (not from - # the instance), so that we can modify it and add the mixin method - phase = getattr(type(self), attr_name) + # Add the methods to the class being created + if PackageMixinsMeta._methods_to_be_added: + attr_dict.update(PackageMixinsMeta._methods_to_be_added) + PackageMixinsMeta._methods_to_be_added.clear() - # Due to MRO, we may have taken a method from a parent class - # and modifying it may influence other packages in unwanted manners. - # Solve the problem by copying the phase into the most derived class. - setattr(type(self), attr_name, phase.copy()) - phase = getattr(type(self), attr_name) + attr_fmt = '_InstallPhase_{0}' - phase.run_after.append( - FilterCompilerWrappers.filter_compilers + # Copy the phases that needs it to the most derived classes + # in order not to interfere with other packages in the hierarchy + phases_to_be_copied = list( + PackageMixinsMeta._add_method_before.keys() + ) + phases_to_be_copied += list( + PackageMixinsMeta._add_method_after.keys() ) - super(FilterCompilerWrappers, self).__init__() + for phase in phases_to_be_copied: - def filter_compilers(self): - """Substitutes any path referring to a Spack compiler wrapper - with the path of the underlying compiler that has been used. + attr_name = attr_fmt.format(phase) - If this isn't done, the files will have CC, CXX, F77, and FC set - to Spack's generic cc, c++, f77, and f90. We want them to - be bound to whatever compiler they were built with. - """ + # Here we want to get the attribute directly from the class (not + # from the instance), so that we can modify it and add the mixin + # method to the pipeline. + phase = getattr(cls, attr_name) + + # Due to MRO, we may have taken a method from a parent class + # and modifying it may influence other packages in unwanted + # manners. Solve the problem by copying the phase into the most + # derived class. + setattr(cls, attr_name, phase.copy()) + + # Insert the methods in the appropriate position + # in the installation pipeline. + + for phase in PackageMixinsMeta._add_method_before: + + attr_name = attr_fmt.format(phase) + phase_obj = getattr(cls, attr_name) + fn_list = PackageMixinsMeta._add_method_after[phase] + + for f in fn_list: + phase_obj.run_before.append(f) + + for phase in PackageMixinsMeta._add_method_after: + + attr_name = attr_fmt.format(phase) + phase_obj = getattr(cls, attr_name) + fn_list = PackageMixinsMeta._add_method_after[phase] + + for f in fn_list: + phase_obj.run_after.append(f) + + super(PackageMixinsMeta, cls).__init__(name, bases, attr_dict) + + +def filter_compiler_wrappers(*files, **kwargs): + """Substitutes any path referring to a Spack compiler wrapper with the + path of the underlying compiler that has been used. + + If this isn't done, the files will have CC, CXX, F77, and FC set to + Spack's generic cc, c++, f77, and f90. We want them to be bound to + whatever compiler they were built with. + + Args: + *files: files to be filtered + **kwargs: at present supports the keyword 'after' to specify after + which phase the files should be filtered (defaults to 'install'). + """ + after = kwargs.get('after', 'install') + + def _filter_compiler_wrappers_impl(self): + + tty.debug('Filtering compiler wrappers: {0}'.format(files)) + + # Compute the absolute path of the files to be filtered and + # remove links from the list. + abs_files = llnl.util.filesystem.find(self.prefix, files) + abs_files = [x for x in abs_files if not os.path.islink(x)] kwargs = {'ignore_absent': True, 'backup': False, 'string': True} - if self.to_be_filtered_for_wrappers: - x = llnl.util.filesystem.FileFilter( - *self.to_be_filtered_for_wrappers - ) + x = llnl.util.filesystem.FileFilter(*abs_files) + + x.filter(os.environ['CC'], self.compiler.cc, **kwargs) + x.filter(os.environ['CXX'], self.compiler.cxx, **kwargs) + x.filter(os.environ['F77'], self.compiler.f77, **kwargs) + x.filter(os.environ['FC'], self.compiler.fc, **kwargs) - x.filter(os.environ['CC'], self.compiler.cc, **kwargs) - x.filter(os.environ['CXX'], self.compiler.cxx, **kwargs) - x.filter(os.environ['F77'], self.compiler.f77, **kwargs) - x.filter(os.environ['FC'], self.compiler.fc, **kwargs) + # Remove this linking flag if present (it turns RPATH into RUNPATH) + x.filter('-Wl,--enable-new-dtags', '', **kwargs) - # Remove this linking flag if present (it turns RPATH into RUNPATH) - x.filter('-Wl,--enable-new-dtags', '', **kwargs) + PackageMixinsMeta.register_method_after( + _filter_compiler_wrappers_impl, after + ) diff --git a/lib/spack/spack/package.py b/lib/spack/spack/package.py index f0172565bb..82af2375af 100644 --- a/lib/spack/spack/package.py +++ b/lib/spack/spack/package.py @@ -56,6 +56,7 @@ import spack.error import spack.fetch_strategy as fs import spack.hooks import spack.mirror +import spack.mixins import spack.repository import spack.url import spack.util.web @@ -141,7 +142,10 @@ class InstallPhase(object): return other -class PackageMeta(spack.directives.DirectiveMetaMixin): +class PackageMeta( + spack.directives.DirectiveMeta, + spack.mixins.PackageMixinsMeta +): """Conveniently transforms attributes to permit extensible phases Iterates over the attribute 'phases' and creates / updates private -- cgit v1.2.3-70-g09d2