Source code for spack.build_systems.waf

# Copyright 2013-2022 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
# SPDX-License-Identifier: (Apache-2.0 OR MIT)

import inspect

from llnl.util.filesystem import working_dir

from spack.directives import depends_on
from spack.package import PackageBase, run_after

[docs]class WafPackage(PackageBase): """Specialized class for packages that are built using the Waf build system. See for more information. This class provides the following phases that can be overridden: * configure * build * install These are all standard Waf commands and can be found by running: .. code-block:: console $ python waf --help Each phase provides a function <phase> that runs: .. code-block:: console $ python waf -j<jobs> <phase> where <jobs> is the number of parallel jobs to build with. Each phase also has a <phase_args> function that can pass arguments to this call. All of these functions are empty except for the ``configure_args`` function, which passes ``--prefix=/path/to/installation/prefix``. """ # Default phases phases = ['configure', 'build', 'install'] # To be used in UI queries that require to know which # build-system class we are using build_system_class = 'WafPackage' # Callback names for build-time test build_time_test_callbacks = ['build_test'] # Callback names for install-time test install_time_test_callbacks = ['install_test'] # Much like AutotoolsPackage does not require automake and autoconf # to build, WafPackage does not require waf to build. It only requires # python to run the waf build script. depends_on('python@2.5:', type='build') @property def build_directory(self): """The directory containing the ``waf`` file.""" return self.stage.source_path
[docs] def python(self, *args, **kwargs): """The python ``Executable``.""" inspect.getmodule(self).python(*args, **kwargs)
[docs] def waf(self, *args, **kwargs): """Runs the waf ``Executable``.""" jobs = inspect.getmodule(self).make_jobs with working_dir(self.build_directory): self.python('waf', '-j{0}'.format(jobs), *args, **kwargs)
[docs] def configure(self, spec, prefix): """Configures the project.""" args = ['--prefix={0}'.format(self.prefix)] args += self.configure_args() self.waf('configure', *args)
[docs] def configure_args(self): """Arguments to pass to configure.""" return []
[docs] def build(self, spec, prefix): """Executes the build.""" args = self.build_args() self.waf('build', *args)
[docs] def build_args(self): """Arguments to pass to build.""" return []
[docs] def install(self, spec, prefix): """Installs the targets on the system.""" args = self.install_args() self.waf('install', *args)
[docs] def install_args(self): """Arguments to pass to install.""" return []
# Testing
[docs] def build_test(self): """Run unit tests after build. By default, does nothing. Override this if you want to add package-specific tests. """ pass
[docs] def install_test(self): """Run unit tests after install. By default, does nothing. Override this if you want to add package-specific tests. """ pass
run_after('install')(PackageBase._run_default_install_time_test_callbacks) # Check that self.prefix is there after installation run_after('install')(PackageBase.sanity_check_prefix)