# Copyright Spack Project Developers. See COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)
"""
Spack allows very fine-grained control over how packages are installed and
over how they are built and configured. To make this easy, it has its own
syntax for declaring a dependence. We call a descriptor of a particular
package configuration a "spec".
The syntax looks like this:
.. code-block:: sh
$ spack install mpileaks ^openmpi @1.2:1.4 +debug %intel @12.1 target=zen
0 1 2 3 4 5 6
The first part of this is the command, ``spack install``. The rest of the
line is a spec for a particular installation of the mpileaks package.
0. The package to install
1. A dependency of the package, prefixed by ``^``
2. A version descriptor for the package. This can either be a specific
version, like ``1.2``, or it can be a range of versions, e.g. ``1.2:1.4``.
If multiple specific versions or multiple ranges are acceptable, they
can be separated by commas, e.g. if a package will only build with
versions 1.0, 1.2-1.4, and 1.6-1.8 of mvapich, you could say::
depends_on("mvapich@1.0,1.2:1.4,1.6:1.8")
3. A compile-time variant of the package. If you need openmpi to be
built in debug mode for your package to work, you can require it by
adding ``+debug`` to the openmpi spec when you depend on it. If you do
NOT want the debug option to be enabled, then replace this with ``-debug``.
If you would like for the variant to be propagated through all your
package's dependencies use ``++`` for enabling and ``--`` or ``~~`` for disabling.
4. The name of the compiler to build with.
5. The versions of the compiler to build with. Note that the identifier
for a compiler version is the same ``@`` that is used for a package version.
A version list denoted by ``@`` is associated with the compiler only if
if it comes immediately after the compiler name. Otherwise it will be
associated with the current package spec.
6. The architecture to build with.
"""
import abc
import collections
import enum
import io
import itertools
import json
import os
import pathlib
import platform
import re
import socket
import warnings
from typing import (
TYPE_CHECKING,
Any,
Callable,
ClassVar,
Deque,
Dict,
Iterable,
Iterator,
List,
Match,
NamedTuple,
Optional,
Sequence,
Set,
Tuple,
Type,
Union,
overload,
)
import spack.vendor.archspec.cpu
from spack.vendor.typing_extensions import Literal
import spack
import spack.aliases
import spack.compilers.flags
import spack.deptypes as dt
import spack.enums
import spack.error
import spack.hash_types as ht
import spack.patch
import spack.paths
import spack.platforms
import spack.provider_index
import spack.repo
import spack.spec_parser
import spack.traverse
import spack.util.filesystem as fs
import spack.util.gpg
import spack.util.hash
import spack.util.path
import spack.util.prefix
import spack.util.spack_json as sjson
import spack.util.spack_yaml as syaml
import spack.util.string
import spack.util.tty.color as clr
import spack.variant as vt
import spack.version
import spack.version as vn
import spack.version.git_ref_lookup
from spack.util import lang, tty
from .enums import PropagationPolicy
SPEC_FORMAT_RE = re.compile(
r"(?:" # this is one big or, with matches ordered by priority
# OPTION 1: escaped character (needs to be first to catch opening \{)
# Note that an unterminated \ at the end of a string is left untouched
r"(?:\\(.))"
r"|" # or
# OPTION 2: an actual format string
r"{" # non-escaped open brace {
r"( ?[%@/]|[\w ][\w -]*=)?" # optional sigil (or identifier or space) to print sigil in color
r"(?:\^([^}\.]+)\.)?" # optional ^depname. (to get attr from dependency)
# after the sigil or depname, we can have a hash expression or another attribute
r"(?:" # one of
r"(hash\b)(?:\:(\d+))?" # hash followed by :<optional length>
r"|" # or
r"([^}]*)" # another attribute to format
r")" # end one of
r"(})?" # finish format string with non-escaped close brace }, or missing if not present
r"|"
# OPTION 3: mismatched close brace (option 2 would consume a matched open brace)
r"(})" # brace
r")",
re.IGNORECASE,
)
#: Valid pattern for an identifier in Spack
IDENTIFIER_RE = r"\w[\w-]*"
# Coloring of specs when using color output. Fields are printed with
# different colors to enhance readability.
# See spack.util.tty.color for descriptions of the color codes.
COMPILER_COLOR = "@g" #: color for highlighting compilers
VERSION_COLOR = "@c" #: color for highlighting versions
ARCHITECTURE_COLOR = "@m" #: color for highlighting architectures
VARIANT_COLOR = "@B" #: color for highlighting variants
HASH_COLOR = "@K" #: color for highlighting package hashes
HIGHLIGHT_COLOR = "@_R" #: color for highlighting spec parts on demand
DIM_COLOR = "@K" #: color for dimmed (grey-out) spec parts
#: Maps PartStyle to a color override; NORMAL is absent so .get(style, default) preserves default
_STYLE_COLOR_MAP = {
spack.enums.PartStyle.HIGHLIGHT: HIGHLIGHT_COLOR,
spack.enums.PartStyle.DIM: DIM_COLOR,
}
#: Default format for Spec.format(). This format can be round-tripped, so that:
#: Spec(Spec("string").format()) == Spec("string)"
DEFAULT_FORMAT = (
"{fullname_if_abstract}{@versions}{compiler_flags}"
"{variants}{ namespace=namespace_if_anonymous}"
"{ platform=architecture.platform}{ os=architecture.os}{ target=architecture.target}"
"{ /abstract_hash}"
)
#: Display format, which eliminates extra `@=` in the output, for readability.
DISPLAY_FORMAT = (
"{name}{@version}{compiler_flags}"
"{variants}{ namespace=namespace_if_anonymous}"
"{ platform=architecture.platform}{ os=architecture.os}{ target=architecture.target}"
"{ /abstract_hash}"
"{compilers}"
)
#: specfile format version. Must increase monotonically
SPECFILE_FORMAT_VERSION = 5
[docs]
class InstallStatus(enum.Enum):
"""Maps install statuses to symbols for display.
Options are artificially disjoint for display purposes
"""
installed = "@g{[+]} "
upstream = "@g{[^]} "
external = "@M{[e]} "
absent = "@K{ - } "
missing = "@r{[-]} "
buildcache = "@g{[b]} "
# regexes used in spec formatting
OLD_STYLE_FMT_RE = re.compile(r"\${[A-Z]+}")
def _make_microarchitecture(name: str) -> spack.vendor.archspec.cpu.Microarchitecture:
if isinstance(name, spack.vendor.archspec.cpu.Microarchitecture):
return name
if name == "*":
# canonicalize target=* to target=: like @: in version lists
name = ":"
elif ":" in name or "," in name:
name = _canonical_target_range(name)
return spack.vendor.archspec.cpu.TARGETS.get(
name, spack.vendor.archspec.cpu.generic_microarchitecture(name)
)
def _closed_interval_targets(
lower: Optional[spack.vendor.archspec.cpu.Microarchitecture],
upper: spack.vendor.archspec.cpu.Microarchitecture,
) -> Set[spack.vendor.archspec.cpu.Microarchitecture]:
"""The targets in the closed interval between the bounds; a None lower bound means the
family root. The set is exact: a target below the upper bound is one of its ancestors, so
no target outside the table can enter the interval."""
candidates = set(upper.ancestors)
candidates.add(upper)
if lower is None:
return candidates
return {t for t in candidates if t >= lower}
def _decompose_target_set(targets: Set[spack.vendor.archspec.cpu.Microarchitecture]) -> List[str]:
"""A deterministic decomposition of a set of targets into interval elements: repeatedly
emit the largest interval that starts at a minimal remaining target and stays inside the
set. The result is a function of the set alone, so lists denoting the same targets
decompose identically; it is not always of minimal length."""
result = []
remaining = set(targets)
while remaining:
m = min((t for t in remaining if not any(s < t for s in remaining)), key=lambda t: t.name)
best, members = m, {m}
for u in sorted(remaining, key=lambda t: t.name):
if not u > m:
continue
candidates = _closed_interval_targets(m, u)
if len(candidates) > len(members) and candidates <= remaining:
best, members = u, candidates
if m == best:
result.append(m.name)
elif m == m.family:
result.append(f":{best.name}")
else:
result.append(f"{m.name}:{best.name}")
remaining -= members
return result
def _canonical_target_range(name: str) -> str:
"""The canonical string representation of a target. For example, `x86_64:icelake` is
canonicalized to `:icelake`. A list is rewritten as a decomposition of the set of targets
it denotes, so that lists denoting the same set, such as `nocona:haswell` and
`nocona:nehalem,nehalem:haswell`, have one canonical form: elements denoting no target
are dropped, and the rest are fused per family."""
elements = set()
for element in name.split(","):
if element == "*":
element = ":"
t_min, t_sep, t_max = element.partition(":")
if t_sep and t_max:
family = _make_microarchitecture(t_max).family.name
if not t_min or t_min == family:
# if the upperbound is a root, canonicalize to the singleton
element = t_max if t_max == family else f":{t_max}"
elif t_min == t_max:
element = t_min
elements.add(element)
if len(elements) <= 1:
return ",".join(elements)
table = spack.vendor.archspec.cpu.TARGETS
opens: Set[str] = set() # lower bounds of `x:` elements
union: Set[spack.vendor.archspec.cpu.Microarchitecture] = set()
verbatim = set() # elements with bounds outside the table cannot be compared
for element in elements:
t_min, t_sep, t_max = element.partition(":")
if not t_min and not t_max:
if t_sep:
# ':' is unbounded on both sides, so it contains every other element
return ":"
verbatim.add(element)
elif (t_min and t_min not in table) or (t_max and t_max not in table):
verbatim.add(element)
elif t_sep and not t_max:
opens.add(t_min)
else:
union |= _closed_interval_targets(
table[t_min] if t_min else None, table[t_max or t_min]
)
if not opens and not union and not verbatim:
# every element denotes the empty set: keep them rather than returning an empty string
return ",".join(sorted(elements))
# keep the antichain of minimal lower bounds: `y:` contains `x:` whenever y is below x
opens = {x for x in opens if not any(table[y] < table[x] for y in opens)}
# an open element already denotes every target above its bound
union = {t for t in union if not any(t >= table[x] for x in opens)}
kept = {f"{x}:" for x in opens} | verbatim
kept.update(_decompose_target_set(union))
return ",".join(sorted(kept))
def _satisfies_target_range(lhs: str, rhs: str) -> bool:
"""Whether every microarchitecture in ``rhs`` is also in ``lhs``."""
lhs_min, lhs_sep, lhs_max = lhs.partition(":")
rhs_min, rhs_sep, rhs_max = rhs.partition(":")
if not rhs_sep:
# rhs is concrete: contained iff it falls within lhs's bounds. Comparing with
# microarchitectures rather than names keeps bounds outside the table from raising.
t = _make_microarchitecture(rhs_min)
if not lhs_sep:
return rhs_min == lhs_min
return (not lhs_min or t >= _make_microarchitecture(lhs_min)) and (
not lhs_max or t <= _make_microarchitecture(lhs_max)
)
if not lhs_sep:
# lhs is concrete: a range is inside it only by denoting that point too.
return rhs_min == rhs_max == lhs_min
# Both are ranges
if lhs_min:
if not rhs_min and not rhs_max:
return False
floor = (
_make_microarchitecture(rhs_min)
if rhs_min
else _make_microarchitecture(rhs_max).family
)
if not floor >= _make_microarchitecture(lhs_min):
return False
if lhs_max:
if not rhs_max or not _make_microarchitecture(rhs_max) <= _make_microarchitecture(lhs_max):
return False
return True
def _covered_by_target_list(element: str, rhs_elements: List[str]) -> bool:
"""Whether every target the element denotes is in one of ``rhs_elements``. An element
inside a single rhs element is covered; a range with an upper bound in the table can also
be covered by several rhs elements jointly, so its targets are checked one by one. An open
element is only inside an open element, since it admits targets outside the table."""
if any(_satisfies_target_range(r, element) for r in rhs_elements):
return True
if len(rhs_elements) == 1:
return False
t_min, t_sep, t_max = element.partition(":")
table = spack.vendor.archspec.cpu.TARGETS
if not t_max or t_max not in table or (t_min and t_min not in table):
# a point is covered element-wise or not at all; so are unknown names
return False
members = _closed_interval_targets(table[t_min] if t_min else None, table[t_max])
return all(any(_satisfies_target_range(r, m.name) for r in rhs_elements) for m in members)
def _parse_target_range(
element: str,
) -> Tuple[
Optional[spack.vendor.archspec.cpu.Microarchitecture],
Optional[spack.vendor.archspec.cpu.Microarchitecture],
]:
"""Returns a tuple of (min, max) with None meaning unbounded. For concrete targets
min == max."""
t_min, t_sep, t_max = element.partition(":")
if not t_sep:
t = _make_microarchitecture(t_min)
return t, t
return (
_make_microarchitecture(t_min) if t_min else None,
_make_microarchitecture(t_max) if t_max else None,
)
@lang.memoized
def _minimal_upper_bounds(
a: Optional[spack.vendor.archspec.cpu.Microarchitecture],
b: Optional[spack.vendor.archspec.cpu.Microarchitecture],
) -> List[Optional[spack.vendor.archspec.cpu.Microarchitecture]]:
"""The minimal targets above both a and b. The target graph is not a lattice, so there is
not always a unique least upper bound: incomparable bounds can have several minimal common
upper bounds. Memoized: the search below scans the whole target table."""
if a is None:
return [b]
if b is None:
return [a]
if a.name == b.name:
return [a]
if a.family != b.family:
return []
if a >= b:
return [a]
if b > a:
return [b]
above = [
t
for t in spack.vendor.archspec.cpu.TARGETS.values()
if t.family == a.family and t >= a and t >= b
]
return [t for t in above if not any(other < t for other in above)]
@lang.memoized
def _maximal_lower_bounds(
a: Optional[spack.vendor.archspec.cpu.Microarchitecture],
b: Optional[spack.vendor.archspec.cpu.Microarchitecture],
) -> List[Optional[spack.vendor.archspec.cpu.Microarchitecture]]:
"""The dual of ``_minimal_upper_bounds``: the maximal targets below both a and b."""
if a is None:
return [b]
if b is None:
return [a]
if a.name == b.name:
return [a]
if a.family != b.family:
return []
if a <= b:
return [a]
if b < a:
return [b]
below = set(a.ancestors) & set(b.ancestors)
return [t for t in below if not any(t < other for other in below)]
[docs]
@lang.lazy_lexicographic_ordering
class ArchSpec:
"""Aggregate the target platform, the operating system and the target microarchitecture."""
@staticmethod
def _attr_satisfies(lhs: Optional[str], rhs: Optional[str]) -> bool:
"""Whether a platform or operating system on the lhs satisfies the one on the rhs."""
if not rhs:
return True
if rhs == "*":
return lhs is not None
return lhs == rhs
@staticmethod
def _attr_intersects(lhs: Optional[str], rhs: Optional[str]) -> bool:
"""Whether a platform or operating system on either side intersect."""
if not lhs or not rhs:
return True
return lhs == "*" or rhs == "*" or lhs == rhs
@staticmethod
def _target_satisfies(
lhs: Optional[spack.vendor.archspec.cpu.Microarchitecture],
rhs: Optional[spack.vendor.archspec.cpu.Microarchitecture],
) -> bool:
"""Whether every microarchitecture in the lhs target is also in the rhs one."""
if not rhs:
return True
if lhs is None:
return False
# Subset test: every target of the lhs must be covered by the rhs
rhs_elements = str(rhs).split(",")
return all(
_covered_by_target_list(l_range, rhs_elements) for l_range in str(lhs).split(",")
)
@staticmethod
def _target_intersects(
lhs: Optional[spack.vendor.archspec.cpu.Microarchitecture],
rhs: Optional[spack.vendor.archspec.cpu.Microarchitecture],
) -> bool:
"""Whether there is a microarchitecture in both targets."""
if not lhs or not rhs:
return True
return bool(ArchSpec._target_intersection(lhs, rhs))
@staticmethod
def _target_intersection(
lhs: Optional[spack.vendor.archspec.cpu.Microarchitecture],
rhs: Optional[spack.vendor.archspec.cpu.Microarchitecture],
) -> List[str]:
"""The elements of the target list denoting the targets both sides contain. Every element
is an interval, so the overlap of two of them starts at a common upper bound of their
lower bounds and ends at a common lower bound of their upper bounds. Those bounds are not
always unique, so one pair of intervals can produce several intervals: one per
combination."""
results: List[str] = []
if not lhs or not rhs:
return results
for l_element in str(lhs).split(","):
for r_element in str(rhs).split(","):
# a concrete element intersects another element iff contained in it, and the
# overlap is the concrete element itself
if ":" not in r_element:
if _satisfies_target_range(l_element, r_element):
results.append(r_element)
continue
if ":" not in l_element:
if _satisfies_target_range(r_element, l_element):
results.append(l_element)
continue
l_min, l_max = _parse_target_range(l_element)
r_min, r_max = _parse_target_range(r_element)
for n_min in _minimal_upper_bounds(l_min, r_min):
for n_max in _maximal_lower_bounds(l_max, r_max):
if n_min is None and n_max is None:
results.append(":")
elif n_min is None:
results.append(f":{n_max}")
elif n_max is None:
results.append(f"{n_min}:")
elif n_min.name == n_max.name:
results.append(n_min.name)
elif n_min.family == n_max.family and n_min <= n_max:
results.append(f"{n_min}:{n_max}")
return results
[docs]
@staticmethod
def default_arch():
"""Return the default architecture"""
platform = spack.platforms.host()
default_os = platform.default_operating_system()
default_target = platform.default_target()
arch_tuple = str(platform), str(default_os), str(default_target)
return ArchSpec(arch_tuple)
__slots__ = "_platform", "_os", "_target"
def __init__(self, spec_or_platform_tuple=(None, None, None)):
"""Architecture specification a package should be built with.
Each ArchSpec is comprised of three elements: a platform (e.g. Linux),
an OS (e.g. RHEL6), and a target (e.g. x86_64).
Args:
spec_or_platform_tuple (ArchSpec or str or tuple): if an ArchSpec
is passed it will be duplicated into the new instance.
Otherwise information on platform, OS and target should be
passed in either as a spec string or as a tuple.
"""
# If the argument to __init__ is a spec string, parse it
# and construct an ArchSpec
def _string_or_none(s):
if s and s != "None":
return str(s)
return None
# If another instance of ArchSpec was passed, duplicate it
if isinstance(spec_or_platform_tuple, ArchSpec):
other = spec_or_platform_tuple
platform_tuple = other.platform, other.os, other.target
elif isinstance(spec_or_platform_tuple, (str, tuple)):
spec_fields = spec_or_platform_tuple
# Normalize the string to a tuple
if isinstance(spec_or_platform_tuple, str):
spec_fields = spec_or_platform_tuple.split("-")
if len(spec_fields) != 3:
msg = "cannot construct an ArchSpec from {0!s}"
raise ValueError(msg.format(spec_or_platform_tuple))
platform, operating_system, target = spec_fields
platform_tuple = (_string_or_none(platform), _string_or_none(operating_system), target)
self.platform, self.os, self.target = platform_tuple
[docs]
@staticmethod
def override(init_spec, change_spec):
if init_spec:
new_spec = init_spec.copy()
else:
new_spec = ArchSpec()
if change_spec.platform:
new_spec.platform = change_spec.platform
# TODO: if the platform is changed to something that is incompatible
# with the current os, we should implicitly remove it
if change_spec.os:
new_spec.os = change_spec.os
if change_spec.target:
new_spec.target = change_spec.target
return new_spec
def _autospec(self, spec_like):
if isinstance(spec_like, ArchSpec):
return spec_like
return ArchSpec(spec_like)
def _cmp_iter(self):
yield self.platform
yield self.os
if self.target is None:
yield self.target
else:
yield self.target.name
@property
def platform(self):
"""The platform of the architecture."""
return self._platform
@platform.setter
def platform(self, value):
# The platform of the architecture spec will be verified as a
# supported Spack platform before it's set to ensure all specs
# refer to valid platforms.
value = str(value) if value is not None else None
self._platform = value
@property
def os(self):
"""The OS of this ArchSpec."""
return self._os
@os.setter
def os(self, value):
# The OS of the architecture spec will update the platform field
# if the OS is set to one of the reserved OS types so that the
# default OS type can be resolved. Since the reserved OS
# information is only available for the host machine, the platform
# will assumed to be the host machine's platform.
value = str(value) if value is not None else None
if value in spack.platforms.Platform.reserved_oss:
curr_platform = str(spack.platforms.host())
self.platform = self.platform or curr_platform
if self.platform != curr_platform:
raise ValueError(
"Can't set arch spec OS to reserved value '%s' when the "
"arch platform (%s) isn't the current platform (%s)"
% (value, self.platform, curr_platform)
)
spec_platform = spack.platforms.by_name(self.platform)
value = str(spec_platform.operating_system(value))
self._os = value
@property
def target(self):
"""The target of the architecture."""
return self._target
@target.setter
def target(self, value):
# The target of the architecture spec will update the platform field
# if the target is set to one of the reserved target types so that
# the default target type can be resolved. Since the reserved target
# information is only available for the host machine, the platform
# will assumed to be the host machine's platform.
def target_or_none(t):
if isinstance(t, spack.vendor.archspec.cpu.Microarchitecture):
return t
if t and t != "None":
return _make_microarchitecture(t)
return None
value = target_or_none(value)
if str(value) in spack.platforms.Platform.reserved_targets:
curr_platform = str(spack.platforms.host())
self.platform = self.platform or curr_platform
if self.platform != curr_platform:
raise ValueError(
"Can't set arch spec target to reserved value '%s' when "
"the arch platform (%s) isn't the current platform (%s)"
% (value, self.platform, curr_platform)
)
spec_platform = spack.platforms.by_name(self.platform)
value = spec_platform.target(value)
self._target = value
[docs]
def satisfies(self, other: "ArchSpec") -> bool:
"""Return True if all concrete specs matching self also match other, otherwise False.
Args:
other: spec to be satisfied
"""
other = self._autospec(other)
return (
self._attr_satisfies(self.platform, other.platform)
and self._attr_satisfies(self.os, other.os)
and self._target_satisfies(self.target, other.target)
)
[docs]
def intersects(self, other: "ArchSpec") -> bool:
"""Return True if there exists at least one concrete spec that matches both
self and other, otherwise False.
This operation is commutative, and if two specs intersect it means that one
can constrain the other.
Args:
other: spec to be checked for compatibility
"""
other = self._autospec(other)
return (
self._attr_intersects(self.platform, other.platform)
and self._attr_intersects(self.os, other.os)
and self._target_intersects(self.target, other.target)
)
def _target_constrain(self, other: "ArchSpec") -> bool:
# An unconstrained target on either side means the other side is the intersection.
# _target_intersection cannot express that: it returns an empty list whenever one of
# the two has no target, which would turn into an empty target below.
if other.target is None:
return False
if self.target is None:
self.target = other.target
return True
results = self._target_intersection(self.target, other.target)
if not results:
raise UnsatisfiableArchitectureSpecError(self, other)
# Targets are stored canonically, so the intersection equals self.target exactly when
# self is already inside other.
intersection_target = _make_microarchitecture(",".join(results))
if self.target == intersection_target:
return False
self.target = intersection_target
return True
[docs]
def constrain(self, other: "ArchSpec") -> bool:
"""Projects all architecture fields that are specified in the given
spec onto the instance spec if they're missing from the instance
spec.
This will only work if the two specs are compatible.
Args:
other (ArchSpec or str): constraints to be added
Returns:
True if the current instance was constrained, False otherwise.
"""
other = self._autospec(other)
if not other.intersects(self):
raise UnsatisfiableArchitectureSpecError(other, self)
constrained = False
for attr in ("platform", "os"):
svalue, ovalue = getattr(self, attr), getattr(other, attr)
# a star constrains the value to be set, so it is kept when there is none yet and
# is replaced by a named value from the other side
if ovalue is not None and (svalue is None or (svalue == "*" and ovalue != "*")):
setattr(self, attr, ovalue)
constrained = True
constrained |= self._target_constrain(other)
return constrained
[docs]
def copy(self):
"""Copy the current instance and returns the clone."""
return ArchSpec(self)
@property
def concrete(self):
"""True if the spec is concrete, False otherwise"""
return self.platform and self.os and self.target and self.target_concrete
@property
def target_concrete(self):
"""True if the target is not a range or list."""
return (
self.target is not None and ":" not in str(self.target) and "," not in str(self.target)
)
[docs]
def to_dict(self):
# Abstract specs may have no target
if self.target is None:
target_data = None
# Generic targets represent either an architecture family (like x86_64)
# or a custom micro-architecture
elif self.target.vendor == "generic":
target_data = str(self.target)
else:
# Get rid of compiler flag information before turning the uarch into a dict
target_data = self.target.to_dict()
target_data.pop("compilers", None)
return {"arch": {"platform": self.platform, "platform_os": self.os, "target": target_data}}
[docs]
@staticmethod
def from_dict(d):
"""Import an ArchSpec from raw YAML/JSON data"""
arch = d["arch"]
target_name = arch["target"]
if target_name is None:
return ArchSpec((arch["platform"], arch["platform_os"], None))
if not isinstance(target_name, str):
target_name = target_name["name"]
target = _make_microarchitecture(target_name)
return ArchSpec((arch["platform"], arch["platform_os"], target))
def __str__(self):
return "%s-%s-%s" % (self.platform, self.os, self.target)
def __repr__(self):
fmt = "ArchSpec(({0.platform!r}, {0.os!r}, {1!r}))"
return fmt.format(self, str(self.target))
def __contains__(self, string):
return string in str(self) or string in self.target
[docs]
def complete_with_defaults(self) -> None:
default_architecture = ArchSpec.default_arch()
if not self.platform:
self.platform = default_architecture.platform
if not self.os:
self.os = default_architecture.os
if not self.target:
self.target = default_architecture.target
[docs]
class CompilerSpec:
"""Adaptor to the old compiler spec interface. Exposes just a few attributes"""
def __init__(self, spec):
self.spec = spec
@property
def name(self):
return self.spec.name
@property
def version(self):
return self.spec.version
@property
def versions(self):
return self.spec.versions
@property
def display_str(self):
"""Equivalent to ``{compiler.name}{@compiler.version}`` for Specs, without extra
``@=`` for readability."""
if self.versions != vn.any_version:
return self.spec.format("{name}{@version}")
return self.spec.format("{name}")
def __lt__(self, other):
if not isinstance(other, CompilerSpec):
return self.spec < other
return self.spec < other.spec
def __eq__(self, other):
if not isinstance(other, CompilerSpec):
return self.spec == other
return self.spec == other.spec
def __hash__(self):
return hash(self.spec)
def __str__(self):
return str(self.spec)
def _cmp_iter(self):
return self.spec._cmp_iter()
def __bool__(self):
if self.spec == Spec():
return False
return bool(self.spec)
[docs]
class DeprecatedCompilerSpec(lang.DeprecatedProperty):
def __init__(self):
super().__init__(name="compiler")
[docs]
def factory(self, instance, owner):
if instance.original_spec_format() < 5:
compiler = instance.annotations.compiler_node_attribute
assert compiler is not None, "a compiler spec is expected"
return CompilerSpec(compiler)
for language in ("c", "cxx", "fortran"):
deps = instance.dependencies(virtuals=language)
if deps:
return CompilerSpec(deps[0])
raise AttributeError(f"{instance} has no C, C++, or Fortran compiler")
[docs]
@lang.lazy_lexicographic_ordering(set_hash=False)
class DependencySpec:
"""DependencySpecs represent an edge in the DAG, and contain dependency types
and information on the virtuals being provided.
Dependencies can be one (or more) of several types:
- build: needs to be in the PATH at build time.
- link: is linked to and added to compiler flags.
- run: needs to be in the PATH for the package to run.
Args:
parent: starting node of the edge
spec: ending node of the edge.
depflag: represents dependency relationships.
virtuals: virtual packages provided from child to parent node.
"""
__slots__ = "parent", "spec", "depflag", "virtuals", "direct", "when", "propagation"
if TYPE_CHECKING:
# lazy_lexicographic_ordering installs these with setattr, unseen by type checkers
def __lt__(self, other: Any) -> bool: ...
def __le__(self, other: Any) -> bool: ...
def __gt__(self, other: Any) -> bool: ...
def __ge__(self, other: Any) -> bool: ...
def __init__(
self,
parent: "Spec",
spec: "Spec",
*,
depflag: dt.DepFlag,
virtuals: Tuple[str, ...],
direct: bool = False,
propagation: PropagationPolicy = PropagationPolicy.NONE,
when: Optional["Spec"] = None,
):
if direct is False and propagation != PropagationPolicy.NONE:
raise InvalidEdgeError("only direct dependencies can be propagated")
self.parent = parent
self.spec = spec
self.depflag = depflag
self.virtuals = tuple(sorted(set(virtuals)))
self.direct = direct
self.propagation = propagation
self.when = when or EMPTY_SPEC
[docs]
def update_deptypes(self, depflag: dt.DepFlag) -> bool:
"""Update the current dependency types"""
old = self.depflag
new = depflag | old
if new == old:
return False
self.depflag = new
return True
[docs]
def update_virtuals(self, virtuals: Union[str, Iterable[str]]) -> bool:
"""Update the list of provided virtuals"""
old = self.virtuals
if isinstance(virtuals, str):
union = {virtuals, *self.virtuals}
else:
union = {*virtuals, *self.virtuals}
if len(union) == len(old):
return False
self.virtuals = tuple(sorted(union))
return True
[docs]
def copy(self, *, keep_virtuals: bool = True, keep_parent: bool = True) -> "DependencySpec":
"""Return a copy of this edge"""
parent = self.parent if keep_parent else Spec()
virtuals = self.virtuals if keep_virtuals else ()
return DependencySpec(
parent,
self.spec,
depflag=self.depflag,
virtuals=virtuals,
propagation=self.propagation,
direct=self.direct,
when=self.when,
)
def _constrain(self, other: "DependencySpec") -> bool:
"""Constrain this edge with another edge. Precondition: parent and child of self and other
are compatible, and both edges have the same when condition. Used as an internal helper
function in Spec.constrain.
Args:
other: edge to use as constraint
Returns:
True if the current edge was changed, False otherwise.
"""
changed = False
changed |= self.spec.constrain(other.spec)
changed |= self.update_deptypes(other.depflag)
changed |= self.update_virtuals(other.virtuals)
if not self.direct and other.direct:
changed = True
self.direct = True
if self.propagation == PropagationPolicy.NONE and other.propagation != self.propagation:
changed = True
self.propagation = other.propagation
return changed
def _cmp_iter(self):
yield self.parent.name if self.parent else None
yield self.spec.name if self.spec else None
yield self.depflag
yield self.virtuals
yield self.direct
yield self.propagation
yield self.when
yield self.spec # tie-breaker for parallel edges: `^foo@1 ^foo+bar`
def __hash__(self):
# Hash edge properties, do not include the node.
return hash(
(
self.parent.name if self.parent else None,
self.spec.name if self.spec else None,
self.depflag,
self.virtuals,
self.direct,
self.propagation,
self.when,
)
)
def __str__(self) -> str:
return self.format()
def __repr__(self) -> str:
keywords = [f"depflag={self.depflag}", f"virtuals={self.virtuals}"]
if self.direct:
keywords.append(f"direct={self.direct}")
if self.when != Spec():
keywords.append(f"when={self.when}")
if self.propagation != PropagationPolicy.NONE:
keywords.append(f"propagation=PropagationPolicy.{self.propagation.name}")
keywords_str = ", ".join(keywords)
return f"DependencySpec({self.parent.format()!r}, {self.spec.format()!r}, {keywords_str})"
[docs]
def flip(self) -> "DependencySpec":
"""Flips the dependency and keeps its type. Drops all other information."""
return DependencySpec(
parent=self.spec, spec=self.parent, depflag=self.depflag, virtuals=()
)
[docs]
class CompilerFlag(str):
"""Will store a flag value and it's propagation value
Args:
value (str): the flag's value
propagate (bool): if ``True`` the flag value will
be passed to the package's dependencies. If
``False`` it will not
flag_group (str): if this flag was introduced along
with several flags via a single source, then
this will store all such flags
source (str): identifies the type of constraint that
introduced this flag (e.g. if a package has
``depends_on(... cflags=-g)``, then the ``source``
for "-g" would indicate ``depends_on``.
"""
propagate: bool
flag_group: str
source: str
def __new__(cls, value, **kwargs):
obj = str.__new__(cls, value)
obj.propagate = kwargs.pop("propagate", False)
obj.flag_group = kwargs.pop("flag_group", value)
obj.source = kwargs.pop("source", None)
return obj
[docs]
def copy(self) -> "CompilerFlag":
return CompilerFlag(
self, propagate=self.propagate, flag_group=self.flag_group, source=self.source
)
[docs]
def to_dict(self) -> Dict[str, Any]:
"""Value and propagation of this flag, unlike ``FlagMap.yaml_entry``, which is its value
only. ``flag_group`` and ``source`` are not included: they are bookkeeping for a single
solve, and nothing reads them back. Attributes that have their default value are
omitted."""
d: Dict[str, Any] = {"value": str(self)}
if self.propagate:
d["propagate"] = True
return d
[docs]
@staticmethod
def from_dict(d: Dict[str, Any]) -> "CompilerFlag":
return CompilerFlag(d["value"], propagate=d.get("propagate", False))
_valid_compiler_flags = ("cflags", "cxxflags", "fflags", "ldflags", "ldlibs", "cppflags")
[docs]
class FlagMap(lang.HashableMap[str, List[CompilerFlag]]):
__slots__ = ()
[docs]
def satisfies(self, other):
return all(f in self and set(self[f]) >= set(other[f]) for f in other)
[docs]
def intersects(self, other):
return True
[docs]
def constrain(self, other):
"""Add all flags in other that aren't in self to self.
Return whether the spec changed.
"""
changed = False
for flag_type in other:
if flag_type not in self:
# copy the list and its flags, so that self and other share no mutable state
self[flag_type] = [f.copy() for f in other[flag_type]]
changed = True
continue
extra_other = set(other[flag_type]) - set(self[flag_type])
if extra_other:
self[flag_type] = list(self[flag_type]) + [
x.copy() for x in other[flag_type] if x in extra_other
]
changed = True
# Next, if any flags in other propagate, we force them to propagate in our case.
other_propagate = {f for f in other[flag_type] if f.propagate}
for f in self[flag_type]:
if not f.propagate and f in other_propagate:
f.propagate = True
changed = True
# TODO: what happens if flag groups with a partial (but not complete)
# intersection specify different behaviors for flag propagation?
return changed
[docs]
def to_dict(self) -> Dict[str, List[Dict[str, Any]]]:
"""Values and propagation of the flags, unlike ``yaml_entry``, which drops everything but
their values."""
return {
flag_type: [flag.to_dict() for flag in flags]
for flag_type, flags in sorted(self.items())
}
[docs]
@staticmethod
def from_dict(d: Dict[str, List[Dict[str, Any]]]) -> "FlagMap":
result = FlagMap()
for flag_type, flags in d.items():
result[flag_type] = [CompilerFlag.from_dict(flag) for flag in flags]
return result
[docs]
@staticmethod
def valid_compiler_flags():
return _valid_compiler_flags
[docs]
def copy(self):
clone = FlagMap()
for flag_type, flags in self.items():
clone[flag_type] = [f.copy() for f in flags]
return clone
[docs]
def add_flag(self, flag_type, value, propagation, flag_group=None, source=None):
"""Stores the flag's value in CompilerFlag and adds it
to the FlagMap
Args:
flag_type (str): the type of flag
value (str): the flag's value that will be added to the flag_type's
corresponding list
propagation (bool): if ``True`` the flag value will be passed to
the packages' dependencies. If``False`` it will not be passed
"""
flag_group = flag_group or value
flag = CompilerFlag(value, propagate=propagation, flag_group=flag_group, source=source)
if flag_type not in self:
self[flag_type] = [flag]
else:
self[flag_type].append(flag)
[docs]
def yaml_entry(self, flag_type):
"""Returns the flag type and a list of the flag values since the
propagation values aren't needed when writing to yaml
Args:
flag_type (str): the type of flag to get values from
Returns the flag_type and a list of the corresponding flags in
string format
"""
return flag_type, [str(flag) for flag in self[flag_type]]
def _cmp_iter(self):
for k, v in sorted(self.dict.items()):
yield k
def flags():
for flag in v:
yield flag
yield flag.propagate
yield flags
def __str__(self):
if not self:
return ""
sorted_items = sorted((k, v) for k, v in self.items() if v)
result = ""
for flag_type, flags in sorted_items:
# Do not sort by propagation yes/no, but group by it, which preserves the order.
for propagate, group in itertools.groupby(flags, key=lambda flag: flag.propagate):
sigil = "==" if propagate else "="
value = spack.spec_parser.quote_if_needed(" ".join(group))
result += f" {flag_type}{sigil}{value}"
# TODO: somehow add this space only if something follows in Spec.format()
if sorted_items:
result += " "
return result
EdgeMap = Dict[str, List[DependencySpec]]
def _add_edge_to_map(edge_map: EdgeMap, key: str, edge: DependencySpec) -> None:
if key in edge_map:
lst = edge_map[key]
lst.append(edge)
lst.sort()
else:
edge_map[key] = [edge]
def _select_edges(
edge_map: EdgeMap,
*,
parent: Optional[str] = None,
child: Optional[str] = None,
depflag: dt.DepFlag = dt.ALL,
virtuals: Optional[Union[str, Sequence[str]]] = None,
) -> List[DependencySpec]:
"""Selects a list of edges and returns them.
If an edge:
- Has *any* of the dependency types passed as argument,
- Matches the parent and/or child name
- Provides *any* of the virtuals passed as argument
then it is selected.
Args:
edge_map: map of edges to select from
parent: name of the parent package; ``""`` selects anonymous parents
child: name of the child package; ``""`` selects anonymous children
depflag: allowed dependency types in flag form
virtuals: list of virtuals or specific virtual on the edge
"""
if not depflag:
return []
# Start from all the edges we store
selected: Iterable[DependencySpec] = itertools.chain.from_iterable(edge_map.values())
# Filter by parent name
if parent is not None:
selected = (d for d in selected if d.parent.name == parent)
# Filter by child name
if child is not None:
selected = (d for d in selected if d.spec.name == child)
# Filter by allowed dependency types
if depflag != dt.ALL:
selected = (dep for dep in selected if not dep.depflag or (depflag & dep.depflag))
# Filter by virtuals
if virtuals is not None:
if isinstance(virtuals, str):
selected = (dep for dep in selected if virtuals in dep.virtuals)
else:
selected = (dep for dep in selected if any(v in dep.virtuals for v in virtuals))
return list(selected)
def _headers_default_handler(spec: "Spec"):
"""Default handler when looking for the 'headers' attribute.
Tries to search for ``*.h`` files recursively starting from
``spec.package.home.include``.
Parameters:
spec: spec that is being queried
Returns:
HeaderList: The headers in ``prefix.include``
Raises:
NoHeadersError: If no headers are found
"""
home = getattr(spec.package, "home")
headers = fs.find_headers("*", root=home.include, recursive=True)
if headers:
return headers
raise spack.error.NoHeadersError(f"Unable to locate {spec.name} headers in {home}")
def _libs_default_handler(spec: "Spec"):
"""Default handler when looking for the 'libs' attribute.
Tries to search for ``lib{spec.name}`` recursively starting from
``spec.package.home``. If ``spec.name`` starts with ``lib``, searches for
``{spec.name}`` instead.
Parameters:
spec: spec that is being queried
Returns:
LibraryList: The libraries found
Raises:
NoLibrariesError: If no libraries are found
"""
# Variable 'name' is passed to function 'find_libraries', which supports
# glob characters. For example, we have a package with a name 'abc-abc'.
# Now, we don't know if the original name of the package is 'abc_abc'
# (and it generates a library 'libabc_abc.so') or 'abc-abc' (and it
# generates a library 'libabc-abc.so'). So, we tell the function
# 'find_libraries' to give us anything that matches 'libabc?abc' and it
# gives us either 'libabc-abc.so' or 'libabc_abc.so' (or an error)
# depending on which one exists (there is a possibility, of course, to
# get something like 'libabcXabc.so, but for now we consider this
# unlikely).
name = spec.name.replace("-", "?")
home = getattr(spec.package, "home")
# Avoid double 'lib' for packages whose names already start with lib
if not name.startswith("lib") and not spec.satisfies("platform=windows"):
name = "lib" + name
# If '+shared' search only for shared library; if '~shared' search only for
# static library; otherwise, first search for shared and then for static.
search_shared = (
[True] if ("+shared" in spec) else ([False] if ("~shared" in spec) else [True, False])
)
for shared in search_shared:
# Since we are searching for link libraries, on Windows search only for
# ".Lib" extensions by default as those represent import libraries for implicit links.
libs = fs.find_libraries(name, home, shared=shared, recursive=True, runtime=False)
if libs:
return libs
raise spack.error.NoLibrariesError(
f"Unable to recursively locate {spec.name} libraries in {home}"
)
[docs]
class ForwardQueryToPackage:
"""Descriptor used to forward queries from Spec to Package"""
def __init__(
self,
attribute_name: str,
default_handler: Optional[Callable[["Spec"], Any]] = None,
_indirect: bool = False,
) -> None:
"""Create a new descriptor.
Parameters:
attribute_name: name of the attribute to be searched for in the Package instance
default_handler: default function to be called if the attribute was not found in the
Package instance
_indirect: temporarily added to redirect a query to another package.
"""
self.attribute_name = attribute_name
self.default = default_handler
self.indirect = _indirect
def __get__(self, instance: "SpecBuildInterface", cls):
"""Retrieves the property from Package using a well defined chain
of responsibility.
The order of call is:
1. if the query was through the name of a virtual package try to
search for the attribute ``{virtual_name}_{attribute_name}``
in Package
2. try to search for attribute ``{attribute_name}`` in Package
3. try to call the default handler
The first call that produces a value will stop the chain.
If no call can handle the request then AttributeError is raised with a
message indicating that no relevant attribute exists.
If a call returns None, an AttributeError is raised with a message
indicating a query failure, e.g. that library files were not found in a
'libs' query.
"""
# TODO: this indirection exist solely for `spec["python"].command` to actually return
# spec["python-venv"].command. It should be removed when `python` is a virtual.
if self.indirect and instance.indirect_spec:
pkg = instance.indirect_spec.package
else:
pkg = instance.wrapped_obj.package
try:
query = instance.last_query
except AttributeError:
# There has been no query yet: this means
# a spec is trying to access its own attributes
_ = instance.wrapped_obj[instance.wrapped_obj.name] # NOQA: ignore=F841
query = instance.last_query
callbacks_chain = []
# First in the chain : specialized attribute for virtual packages
if query.isvirtual:
specialized_name = "{0}_{1}".format(query.name, self.attribute_name)
callbacks_chain.append(lambda: getattr(pkg, specialized_name))
# Try to get the generic method from Package
callbacks_chain.append(lambda: getattr(pkg, self.attribute_name))
# Final resort : default callback
if self.default is not None:
_default = self.default # make mypy happy
callbacks_chain.append(lambda: _default(instance.wrapped_obj))
# Trigger the callbacks in order, the first one producing a
# value wins
value = None
message = None
for f in callbacks_chain:
try:
value = f()
# A callback can return None to trigger an error indicating
# that the query failed.
if value is None:
msg = "Query of package '{name}' for '{attrib}' failed\n"
msg += "\tprefix : {spec.prefix}\n"
msg += "\tspec : {spec}\n"
msg += "\tqueried as : {query.name}\n"
msg += "\textra parameters : {query.extra_parameters}"
message = msg.format(
name=pkg.name,
attrib=self.attribute_name,
spec=instance,
query=instance.last_query,
)
else:
return value
break
except AttributeError:
pass
# value is 'None'
if message is not None:
# Here we can use another type of exception. If we do that, the
# unit test 'test_getitem_exceptional_paths' in the file
# lib/spack/spack/test/spec_dag.py will need to be updated to match
# the type.
raise AttributeError(message)
# 'None' value at this point means that there are no appropriate
# properties defined and no default handler, or that all callbacks
# raised AttributeError. In this case, we raise AttributeError with an
# appropriate message.
fmt = "'{name}' package has no relevant attribute '{query}'\n"
fmt += "\tspec : '{spec}'\n"
fmt += "\tqueried as : '{spec.last_query.name}'\n"
fmt += "\textra parameters : '{spec.last_query.extra_parameters}'\n"
message = fmt.format(name=pkg.name, query=self.attribute_name, spec=instance)
raise AttributeError(message)
def __set__(self, instance, value):
cls_name = type(instance).__name__
msg = "'{0}' object attribute '{1}' is read-only"
raise AttributeError(msg.format(cls_name, self.attribute_name))
# Represents a query state in a BuildInterface object
QueryState = collections.namedtuple("QueryState", ["name", "extra_parameters", "isvirtual"])
[docs]
def tree(
specs: List["Spec"],
*,
color: Optional[bool] = None,
depth: bool = False,
hashes: bool = False,
hashlen: Optional[int] = None,
cover: spack.traverse.CoverType = "nodes",
indent: int = 0,
format: str = DEFAULT_FORMAT,
deptypes: Union[dt.DepFlag, dt.DepTypes] = dt.ALL,
show_types: bool = False,
depth_first: bool = False,
recurse_dependencies: bool = True,
status_fn: Optional[Callable[["Spec"], InstallStatus]] = None,
prefix: Optional[Callable[["Spec"], str]] = None,
key: Callable[["Spec"], Any] = id,
version_style_fn: Optional[Callable[["Spec"], spack.enums.PartStyle]] = None,
variant_style_fn: Optional[Callable[["Spec", str], spack.enums.PartStyle]] = None,
architecture_style_fn: Optional[Callable[["Spec", str], spack.enums.PartStyle]] = None,
) -> str:
"""Prints out specs and their dependencies, tree-formatted with indentation.
Status function may either output a boolean or an InstallStatus
Args:
color: if True, always colorize the tree. If False, don't colorize the tree. If None,
use the default from spack.util.tty.color
depth: print the depth from the root
hashes: if True, print the hash of each node
hashlen: length of the hash to be printed
cover: either ``"nodes"`` or ``"edges"``
indent: extra indentation for the tree being printed
format: format to be used to print each node
deptypes: dependency types to be represented in the tree
show_types: if True, show the (merged) dependency type of a node
depth_first: if True, traverse the DAG depth first when representing it as a tree
recurse_dependencies: if True, recurse on dependencies
status_fn: optional callable that takes a node as an argument and return its
installation status
prefix: optional callable that takes a node as an argument and return its
installation prefix
version_style_fn: optional callable ``(node) -> PartStyle`` controlling version rendering
variant_style_fn: optional callable ``(node, key) -> PartStyle`` controlling variant
rendering
architecture_style_fn: optional callable ``(node, part) -> PartStyle`` controlling
architecture part rendering
"""
out = ""
if color is None:
color = clr.get_color_when()
# reduce deptypes over all in-edges when covering nodes
if show_types and cover == "nodes":
deptype_lookup: Dict[str, dt.DepFlag] = collections.defaultdict(dt.DepFlag)
for edge in spack.traverse.traverse_edges(
specs, cover="edges", deptype=deptypes, root=False
):
deptype_lookup[edge.spec.dag_hash()] |= edge.depflag
sorted_specs: List["Spec"] = sorted(specs)
for d, dep_spec in spack.traverse.traverse_tree(
sorted_specs, cover=cover, deptype=deptypes, depth_first=depth_first, key=key
):
node = dep_spec.spec
if prefix is not None:
out += prefix(node)
out += " " * indent
if depth:
out += "%-4d" % d
if status_fn:
status = status_fn(node)
if status in list(InstallStatus):
out += clr.colorize(status.value, color=color)
elif status:
out += clr.colorize("@g{[+]} ", color=color)
else:
out += clr.colorize("@r{[-]} ", color=color)
if hashes:
out += clr.colorize("@K{%s} ", color=color) % node.dag_hash(hashlen)
if show_types:
if cover == "nodes":
depflag = deptype_lookup[dep_spec.spec.dag_hash()]
else:
# when covering edges or paths, we show dependency
# types only for the edge through which we visited
depflag = dep_spec.depflag
type_chars = dt.flag_to_chars(depflag)
out += "[%s] " % type_chars
out += " " * d
if d > 0:
out += "^"
out += (
node.format(
format,
color=color,
version_style_fn=version_style_fn,
variant_style_fn=variant_style_fn,
architecture_style_fn=architecture_style_fn,
)
+ "\n"
)
# Check if we wanted just the first line
if not recurse_dependencies:
break
return out
[docs]
class SpecAnnotations:
__slots__ = ("original_spec_format", "compiler_node_attribute")
def __init__(self) -> None:
self.original_spec_format = SPECFILE_FORMAT_VERSION
self.compiler_node_attribute: Optional["Spec"] = None
[docs]
def with_compiler(self, compiler: "Spec") -> "SpecAnnotations":
self.compiler_node_attribute = compiler
return self
def __repr__(self) -> str:
result = f"SpecAnnotations().with_spec_format({self.original_spec_format})"
if self.compiler_node_attribute:
result += f".with_compiler({str(self.compiler_node_attribute)})"
return result
def _anonymous_star(dep: DependencySpec, dep_format: str) -> str:
"""Determine if a spec needs a star to disambiguate it from an anonymous spec w/variants.
Returns:
"*" if a star is needed, "" otherwise
"""
# named spec never needs star
if dep.spec.name:
return ""
# virtuals without a name always need *: %c=* @4.0 foo=bar
if dep.virtuals:
return "*"
# versions are first so checking for @ is faster than != VersionList(':')
if dep_format.startswith("@"):
return ""
# compiler flags are key-value pairs and can be ambiguous with virtual assignment
if dep.spec.compiler_flags:
return "*"
# booleans come first, and they don't need a star. key-value pairs do. If there are
# no key value pairs, we're left with either an empty spec, which needs * as in
# '^*', or we're left with arch, which is a key value pair, and needs a star.
if not any(v.type == vt.VariantType.BOOL for v in dep.spec.variants.values()):
return "*"
return "*" if dep.spec.architecture else ""
def _satisfying_edges(
lhs_node: "Spec", rhs_edge: DependencySpec, *, resolve_virtuals: bool
) -> Iterator[DependencySpec]:
"""Yield every edge in ``lhs_node`` that satisfies ``rhs_edge`` structurally, ignoring the
target's own dependencies, in priority order: direct deps of all types, then the historical
compiler node, then a BFS over transitive link/run deps."""
# First check direct deps of all types. There is a subtlety: only abstract specs distinguish
# between direct and indirect edges, whereas concrete specs always have direct edges (without
# setting the direct flag). For performance, iterate the _dependencies edge map directly:
# edges_to_dependencies allocates an iterator chain and a result list per call.
require_direct = rhs_edge.direct and not lhs_node.concrete
for edges in lhs_node._dependencies.values():
for lhs_edge in edges:
if require_direct and not lhs_edge.direct:
continue
if _satisfies_edge_attributes(lhs_edge, rhs_edge, resolve_virtuals):
yield lhs_edge
# Include the historical compiler node if available as an ad-hoc edge.
compiler_spec = lhs_node.annotations.compiler_node_attribute
if compiler_spec is not None:
compiler_edge = DependencySpec(
lhs_node,
compiler_spec,
depflag=dt.BUILD,
virtuals=("c", "cxx", "fortran"),
direct=True,
)
if _satisfies_edge_attributes(compiler_edge, rhs_edge, resolve_virtuals):
yield compiler_edge
if rhs_edge.direct:
return
# BFS through link/run transitive deps (skip depth 1, already checked). Nodes with multiple
# in-edges are expanded only once, but every in-edge is a candidate. Deptype sets are lower
# bounds, so only an edge that overlaps link/run guarantees a link/run edge in every
# concretization; an edge with depflag 0 guarantees nothing and is not traversed. For
# performance, iterate the _dependencies edge map directly instead of going through
# edges_to_dependencies.
depflag = dt.LINK | dt.RUN
queue: Deque[DependencySpec] = collections.deque()
queue.extend(
e for edges in lhs_node._dependencies.values() for e in edges if e.depflag & depflag
)
expanded = {id(lhs_node)}
while queue:
lhs_edge = queue.popleft()
# depth 1 was yielded by the loop over direct edges above
if lhs_edge.parent is not lhs_node and _satisfies_edge_attributes(
lhs_edge, rhs_edge, resolve_virtuals
):
yield lhs_edge
if id(lhs_edge.spec) not in expanded:
expanded.add(id(lhs_edge.spec))
if lhs_edge.spec._dependencies:
queue.extend(
e
for edges in lhs_edge.spec._dependencies.values()
for e in edges
if e.depflag & depflag
)
def _satisfies_dependencies(lhs: "Spec", rhs: "Spec", *, resolve_virtuals: bool) -> bool:
"""Whether every dependency edge of ``rhs`` is satisfied by some edge of ``lhs``."""
# For performance, iterate the _dependencies edge map directly instead of going through
# edges_to_dependencies.
for rhs_edges in rhs._dependencies.values():
for rhs_edge in rhs_edges:
# Skip rhs edges whose when condition doesn't apply to the lhs node.
if rhs_edge.when is not EMPTY_SPEC and not lhs._intersects(
rhs_edge.when, resolve_virtuals=resolve_virtuals
):
continue
edges = _satisfying_edges(lhs, rhs_edge, resolve_virtuals=resolve_virtuals)
if rhs_edge.spec.concrete or not rhs_edge.spec._dependencies:
if next(edges, None) is None:
return False
elif not any(
_satisfies_dependencies(e.spec, rhs_edge.spec, resolve_virtuals=resolve_virtuals)
for e in edges
):
return False
return True
[docs]
def constrains_only_name_and_versions(spec: "Spec") -> bool:
"""Whether the spec constrains nothing beyond its package name and versions."""
return (
not spec.variants
and not spec.compiler_flags
and spec.architecture is None
and spec.namespace is None
and not spec.abstract_hash
and not spec._dependencies
)
def _satisfies_edge_attributes(
lhs: "DependencySpec", rhs: "DependencySpec", resolve_virtuals: bool
) -> bool:
"""Helper function for satisfaction tests, which checks edge attributes and the target node.
It skips verification of the parent node."""
name_mismatch = rhs.spec.name and lhs.spec.name != rhs.spec.name
if name_mismatch and rhs.spec.name not in lhs.virtuals:
return False
if not rhs.when._satisfies(lhs.when, resolve_virtuals=resolve_virtuals):
return False
# Subset semantics for virtuals
for v in rhs.virtuals:
if v not in lhs.virtuals:
return False
# Subset semantics for dependency types
if (lhs.depflag & rhs.depflag) != rhs.depflag:
return False
if not name_mismatch:
return lhs.spec._satisfies_node(rhs.spec, resolve_virtuals=resolve_virtuals)
# Right-hand side is a virtual provided by the left-hand side. Virtuals currently support only
# names and versions, so if anything else is set on the rhs we return false, which allows
# future implementation to relax it once variants on virtuals become meaningful.
if not constrains_only_name_and_versions(rhs.spec):
return False
if rhs.spec.versions == spack.version.any_version:
return True
if not resolve_virtuals:
return False
return lhs.spec._provides_virtual(rhs.spec)
def _same_direct_dep(lhs: DependencySpec, rhs: DependencySpec) -> bool:
"""Two edges of one parent refer to the same dependency when they are direct deps, refer to the
same package name, and have the same when condition.
Note that concrete specs exist that can have two distinct providers for a single virtual, so
we do not combine ``^virtual=x ^virtual=y``; we only enforce uniqueness on direct deps."""
return (
lhs.direct
and rhs.direct
and bool(lhs.spec.name)
and lhs.spec.name == rhs.spec.name
and lhs.when == rhs.when
)
def _satisfies_edge(lhs: DependencySpec, rhs: DependencySpec, resolve_virtuals: bool) -> bool:
"""Whether every DAG satisfying ``lhs`` satisfies ``rhs``."""
# Only a direct dependency can satisfy a direct dependency. _satisfies_edge_attributes does
# not compare this itself: its other caller, _satisfying_edges, filters on it externally,
# on fully built specs, unlike _add_or_merge_edge, whose parent node can still be under
# construction.
if rhs.direct and not lhs.direct:
return False
if not _satisfies_edge_attributes(lhs, rhs, resolve_virtuals):
return False
# A concrete or leaf rhs child needs no recursion: _satisfies_edge_attributes compared the
# child node already. A dependency of rhs's child that lhs's child lacks has to be checked:
# the two are independent requirements that a concretization can satisfy with two distinct
# nodes, and a single edge requiring both would exclude those DAGs.
if rhs.spec.concrete or not rhs.spec._dependencies:
return True
return _satisfies_dependencies(lhs.spec, rhs.spec, resolve_virtuals=resolve_virtuals)
def _edge_is_redundant(
edge: DependencySpec, given: DependencySpec, resolve_virtuals: bool
) -> bool:
# %foo and %%foo satisfy each other in both directions; they do not restrict the solution space
# but only influence optimality. That means that edge redundancy cannot be based on satisfies
# only, hence the exception.
if edge.propagation != PropagationPolicy.NONE and given.propagation != edge.propagation:
return False
if edge.spec.name != given.spec.name:
# keep ^mpi@3 next to ^mpi=mpich@3: whether mpich@3 provides mpi@3 is package metadata
resolve_virtuals = False
return _satisfies_edge(given, edge, resolve_virtuals)
[docs]
@lang.lazy_lexicographic_ordering(set_hash=False)
class Spec:
compiler = DeprecatedCompilerSpec()
if TYPE_CHECKING:
# lazy_lexicographic_ordering installs these with setattr, unseen by type checkers
def __lt__(self, other: Any) -> bool: ...
def __le__(self, other: Any) -> bool: ...
def __gt__(self, other: Any) -> bool: ...
def __ge__(self, other: Any) -> bool: ...
[docs]
@staticmethod
def default_arch():
"""Return an anonymous spec for the default architecture"""
s = Spec()
s.architecture = ArchSpec.default_arch()
return s
def __init__(self, spec_like=None, *, external_path=None, external_modules=None):
"""Create a new Spec.
Arguments:
spec_like: if not provided, we initialize an anonymous Spec that matches any Spec;
if provided we parse this as a Spec string, or we copy the provided Spec.
Keyword arguments:
external_path: prefix, if this is a spec for an external package
external_modules: list of external modules, for an external package using modules
"""
# Copy if spec_like is a Spec.
if isinstance(spec_like, Spec):
self._dup(spec_like)
return
# init an empty spec that matches anything.
self.name: str = ""
self.versions = vn.VersionList.any()
self.variants = VariantMap()
self.architecture = None
self.compiler_flags = FlagMap()
self._dependents = {}
self._dependencies = {}
self.namespace = None
self.abstract_hash = None
# initial values for all spec hash types
self._hash = None
self._package_hash = None
self._full_hash = None
self._build_hash = None
# cache for spec's prefix, computed lazily by prefix property
self._prefix = None
# Python __hash__ is handled separately from the cached spec hashes
self._dunder_hash = None
# cache of package for this spec
self._package = None
# whether the spec is concrete or not; set at the end of concretization
self._concrete = False
# External detection details that can be set by internal Spack calls
# in the constructor.
self._external_path = external_path
if external_modules:
self.external_modules = list(external_modules)
else:
self.external_modules = None
# This attribute is used to store custom information for external specs.
self.extra_attributes: Dict[str, Any] = {}
# This attribute holds the original build copy of the spec if it is
# deployed differently than it was built. None signals that the spec
# is deployed "as built."
# Build spec should be the actual build spec unless marked dirty.
self._build_spec = None
self.annotations = SpecAnnotations()
if isinstance(spec_like, str):
spack.spec_parser.parse_one_or_raise(spec_like, self)
elif spec_like is not None:
raise TypeError(f"Can't make spec out of {type(spec_like)}")
@property
def external_path(self):
return spack.util.path.path_to_os_path(self._external_path)[0]
@external_path.setter
def external_path(self, ext_path):
self._external_path = ext_path
@property
def external(self):
return bool(self.external_path) or bool(self.external_modules)
@property
def is_develop(self):
"""Return whether the Spec represents a user-developed package
in a Spack Environment (i.e. using ``spack develop``).
"""
return bool(self.variants.get("dev_path", False))
[docs]
def clear_dependencies(self):
"""Trim the dependencies of this spec."""
self._dependencies.clear()
[docs]
def clear_edges(self):
"""Trim the dependencies and dependents of this spec."""
self._dependencies.clear()
self._dependents.clear()
[docs]
def detach(self, deptype="all"):
"""Remove any reference that dependencies have of this node.
Args:
deptype (str or tuple): dependency types tracked by the
current spec
"""
key = self.dag_hash()
# Go through the dependencies
for dep in self.dependencies(deptype=deptype):
# Remove the spec from dependents
if self.name in dep._dependents:
dependents_copy = dep._dependents[self.name]
del dep._dependents[self.name]
for edge in dependents_copy:
if edge.parent.dag_hash() == key:
continue
_add_edge_to_map(dep._dependents, edge.parent.name, edge)
def _get_dependency(self, name):
# WARNING: This function is an implementation detail of the
# WARNING: original concretizer. Since with that greedy
# WARNING: algorithm we don't allow multiple nodes from
# WARNING: the same package in a DAG, here we hard-code
# WARNING: using index 0 i.e. we assume that we have only
# WARNING: one edge from package "name"
deps = self.edges_to_dependencies(name=name)
if len(deps) != 1:
err_msg = 'expected only 1 "{0}" dependency, but got {1}'
raise spack.error.SpecError(err_msg.format(name, len(deps)))
return deps[0]
[docs]
def edges_from_dependents(
self,
name: Optional[str] = None,
depflag: dt.DepFlag = dt.ALL,
*,
virtuals: Optional[Union[str, Sequence[str]]] = None,
) -> List[DependencySpec]:
"""Return a list of edges connecting this node in the DAG
to parents.
Args:
name: filter dependents by package name; ``""`` selects anonymous dependents
depflag: allowed dependency types
virtuals: allowed virtuals
"""
return _select_edges(self._dependents, parent=name, depflag=depflag, virtuals=virtuals)
[docs]
def edges_to_dependencies(
self,
name: Optional[str] = None,
depflag: dt.DepFlag = dt.ALL,
*,
virtuals: Optional[Union[str, Sequence[str]]] = None,
) -> List[DependencySpec]:
"""Returns a list of edges connecting this node in the DAG to children.
Args:
name: filter dependencies by package name; ``""`` selects anonymous dependencies
depflag: allowed dependency types
virtuals: allowed virtuals
"""
return _select_edges(self._dependencies, child=name, depflag=depflag, virtuals=virtuals)
@property
def edge_attributes(self) -> str:
"""Helper method to print edge attributes in spec strings."""
edges = self.edges_from_dependents()
if not edges:
return ""
union = DependencySpec(parent=Spec(), spec=self, depflag=0, virtuals=())
all_direct_edges = all(x.direct for x in edges)
dep_conditions = set()
for edge in edges:
union.update_deptypes(edge.depflag)
union.update_virtuals(edge.virtuals)
dep_conditions.add(edge.when)
deptypes_str = ""
if not all_direct_edges and union.depflag:
deptypes_str = f"deptypes={','.join(dt.flag_to_tuple(union.depflag))}"
virtuals_str = f"virtuals={','.join(union.virtuals)}" if union.virtuals else ""
conditions = [str(c) for c in dep_conditions if c != Spec()]
when_str = f"when='{','.join(conditions)}'" if conditions else ""
result = " ".join(filter(lambda x: bool(x), (when_str, deptypes_str, virtuals_str)))
if result:
result = f"[{result}]"
return result
[docs]
def dependencies(
self,
name: Optional[str] = None,
deptype: Union[dt.DepTypes, dt.DepFlag] = dt.ALL,
*,
virtuals: Optional[Union[str, Sequence[str]]] = None,
) -> List["Spec"]:
"""Returns a list of direct dependencies (nodes in the DAG)
Args:
name: filter dependencies by package name; ``""`` selects anonymous dependencies
deptype: allowed dependency types
virtuals: allowed virtuals
"""
if not isinstance(deptype, dt.DepFlag):
deptype = dt.canonicalize(deptype)
return [
d.spec for d in self.edges_to_dependencies(name, depflag=deptype, virtuals=virtuals)
]
[docs]
def dependents(
self, name: Optional[str] = None, deptype: Union[dt.DepTypes, dt.DepFlag] = dt.ALL
) -> List["Spec"]:
"""Return a list of direct dependents (nodes in the DAG).
Args:
name: filter dependents by package name; ``""`` selects anonymous dependents
deptype: allowed dependency types
"""
if not isinstance(deptype, dt.DepFlag):
deptype = dt.canonicalize(deptype)
return [d.parent for d in self.edges_from_dependents(name, depflag=deptype)]
def _dependencies_dict(self, depflag: dt.DepFlag = dt.ALL) -> EdgeMap:
"""Return a dictionary, keyed by package name, of the direct
dependencies.
Each value in the dictionary is a list of edges.
Args:
deptype: allowed dependency types
"""
result: EdgeMap = {}
for edge in _select_edges(self._dependencies, depflag=depflag):
result.setdefault(edge.spec.name, []).append(edge)
for edges in result.values():
if len(edges) > 1:
edges.sort()
return result
def _add_flag(
self, name: str, value: Union[str, bool], propagate: bool, concrete: bool
) -> None:
"""Called by the parser to add a known flag"""
if propagate and name in vt.RESERVED_NAMES:
raise UnsupportedPropagationError(
f"Propagation with '==' is not supported for '{name}'."
)
if name == "arch" or name == "architecture":
assert type(value) is str, "architecture have a string value"
parts = tuple(value.split("-"))
plat, os, tgt = parts if len(parts) == 3 else (None, None, value)
self._set_architecture(platform=plat, os=os, target=tgt)
elif name == "platform":
self._set_architecture(platform=value)
elif name == "os" or name == "operating_system":
self._set_architecture(os=value)
elif name == "target":
self._set_architecture(target=value)
elif name == "namespace":
self.namespace = value
elif name in _valid_compiler_flags:
assert self.compiler_flags is not None
assert type(value) is str, f"{name} must have a string value"
flags_and_propagation = spack.compilers.flags.tokenize_flags(value, propagate)
flag_group = " ".join(x for (x, y) in flags_and_propagation)
for flag, propagation in flags_and_propagation:
self.compiler_flags.add_flag(name, flag, propagation, flag_group)
else:
self.variants[name] = vt.VariantValue.from_string_or_bool(
name, value, propagate=propagate, concrete=concrete
)
def _set_architecture(self, **kwargs):
"""Called by the parser to set the architecture."""
arch_attrs = ["platform", "os", "target"]
if self.architecture and self.architecture.concrete:
raise DuplicateArchitectureError("Spec cannot have two architectures.")
if not self.architecture:
new_vals = tuple(kwargs.get(arg, None) for arg in arch_attrs)
self.architecture = ArchSpec(new_vals)
else:
new_attrvals = [(a, v) for a, v in kwargs.items() if a in arch_attrs]
for new_attr, new_value in new_attrvals:
if getattr(self.architecture, new_attr):
raise DuplicateArchitectureError(f"Cannot specify '{new_attr}' twice")
else:
setattr(self.architecture, new_attr, new_value)
def _add_dependency(
self,
spec: "Spec",
*,
depflag: dt.DepFlag,
virtuals: Tuple[str, ...],
direct: bool = False,
propagation: PropagationPolicy = PropagationPolicy.NONE,
when: Optional["Spec"] = None,
):
"""Called by the parser to add another spec as a dependency.
Args:
depflag: dependency type for this edge
virtuals: virtuals on this edge
direct: if True denotes a direct dependency (associated with the % sigil)
propagation: propagation policy for this edge
when: optional condition under which dependency holds
"""
self.add_dependency_edge(
spec,
depflag=depflag,
virtuals=virtuals,
direct=direct,
when=when,
propagation=propagation,
)
[docs]
def add_dependency_edge(
self,
dependency_spec: "Spec",
*,
depflag: dt.DepFlag,
virtuals: Tuple[str, ...],
direct: bool = False,
propagation: PropagationPolicy = PropagationPolicy.NONE,
when: Optional["Spec"] = None,
):
"""Add a dependency edge to this spec.
Args:
dependency_spec: spec of the dependency
depflag: dependency type for this edge
virtuals: virtuals provided by this edge
direct: if True denotes a direct dependency
propagation: propagation policy for this edge
when: if non-None, condition under which dependency holds
"""
if when is None:
when = EMPTY_SPEC
# An edge object already registered on both the parent and the child is updated in place,
# rather than treated as a second, competing constraint: both sides have to see the same
# modification.
for edge in self._dependencies.get(dependency_spec.name, []):
if id(dependency_spec) == id(edge.spec) and edge.when == when:
edge.update_deptypes(depflag=depflag)
edge.update_virtuals(virtuals=virtuals)
return
candidate = DependencySpec(
self,
dependency_spec,
depflag=depflag,
virtuals=virtuals,
direct=direct,
propagation=propagation,
when=when,
)
self._add_or_merge_edge(candidate)
def _add_or_merge_edge(
self, candidate: DependencySpec, owned: bool = True, resolve_virtuals: bool = False
) -> bool:
"""Add ``candidate`` as a dependency edge.
With ``owned`` False the candidate's child still belongs to another DAG: a merge only
reads it, and an append replaces it with a copy first.
The candidate is merged into an existing edge when no concretization can satisfy the
two with separate dependencies (``_same_direct_dep``). A candidate that adds nothing to
an existing edge (``_edge_is_redundant``) is discarded, and existing edges made
redundant by the candidate are detached in its favor. Anything else is a new constraint
and is appended as a parallel edge: whether it ends up sharing a node with another edge
to the same name is for concretization to decide.
The ``_same_direct_dep`` scan compares pairs with identical package names only, because
anonymous specs can refer to different nodes. The redundancy scans compare every pair of
edges. Across different names the comparison does not resolve virtuals, so a ``^virtual``
edge is redundant only against an edge listing it in its ``virtuals`` attribute, and
only when it constrains nothing but the name. An anonymous edge is redundant when any edge
satisfies it; a named edge is never redundant against an anonymous one.
Returns True if ``self`` changed.
Raises:
spack.error.UnsatisfiableSpecError: if two direct dependencies that can only be a
single dependency have children that do not intersect.
"""
name = candidate.spec.name
bucket = self._dependencies.get(name) or []
# A package has at most one direct dependency per name, so an unconditional direct dep
# is merged into an existing one (_same_direct_dep) by constraining, the only merge
# that can raise.
merged_edge: Optional[DependencySpec] = None
if name and candidate.when is EMPTY_SPEC:
for edge in bucket:
if _same_direct_dep(edge, candidate):
merged_edge = edge
break
if merged_edge is None and any(
_edge_is_redundant(candidate, edge, resolve_virtuals)
for edges in self._dependencies.values()
for edge in edges
):
return False
# Constrain before detaching: a failed merge raises with self unchanged.
changed = merged_edge._constrain(candidate) if merged_edge is not None else False
for edge in [
edge
for edges in self._dependencies.values()
for edge in edges
if edge is not merged_edge and _edge_is_redundant(edge, candidate, resolve_virtuals)
]:
self._detach_edge(edge)
changed = True
if merged_edge is not None:
return changed
if not owned:
candidate.spec = candidate.spec.copy(deps=True)
_add_edge_to_map(self._dependencies, candidate.spec.name, candidate)
_add_edge_to_map(candidate.spec._dependents, self.name, candidate)
return True
def _detach_edge(self, edge: DependencySpec) -> None:
"""Remove an edge from this spec and from the dependents of the node it points at.
A bucket that runs empty is deleted: consumers distinguish "no dependents" by the
absence of the key, not by an empty list."""
remaining = [e for e in self._dependencies[edge.spec.name] if e is not edge]
if remaining:
self._dependencies[edge.spec.name] = remaining
else:
del self._dependencies[edge.spec.name]
dependents = edge.spec._dependents
remaining = [e for e in dependents[self.name] if e is not edge]
if remaining:
dependents[self.name] = remaining
else:
del dependents[self.name]
#
# Public interface
#
@property
def fullname(self):
return (
f"{self.namespace}.{self.name}" if self.namespace else (self.name if self.name else "")
)
@property
def anonymous(self):
return not self.name and not self.abstract_hash
@property
def root(self):
"""Follow dependent links and find the root of this spec's DAG.
Spack specs have a single root (the package being installed).
"""
# FIXME: In the case of multiple parents this property does not
# FIXME: make sense. Should we revisit the semantics?
if not self._dependents:
return self
edges_by_package = next(iter(self._dependents.values()))
return edges_by_package[0].parent.root
@property
def package(self):
assert self.concrete, "{0}: Spec.package can only be called on concrete specs".format(
self.name
)
if not self._package:
self._package = spack.repo.PATH.get(self)
return self._package
@property
def concrete(self):
"""A spec is concrete if it describes a single build of a package.
More formally, a spec is concrete if concretize() has been called
on it and it has been marked ``_concrete``.
Concrete specs either can be or have been built. All constraints
have been resolved, optional dependencies have been added or
removed, a compiler has been chosen, and all variants have
values.
"""
return self._concrete
@property
def spliced(self):
"""Returns whether this Spec is being deployed as built i.e. whether it has been spliced"""
return self.build_spec is not self
@property
def installed(self):
"""Whether the spec is installed, locally or in an upstream."""
if not self.concrete:
return False
try:
# If the spec is in the DB, check the installed
# attribute of the record
from spack.store import STORE
return STORE.db.get_record(self).installed
except KeyError:
# If the spec is not in the DB, the method
# above raises a Key error
return False
@property
def installed_upstream(self):
"""Whether the spec is installed in an upstream database."""
if not self.concrete:
return False
from spack.store import STORE
upstream, record = STORE.db.query_by_spec_hash(self.dag_hash())
return upstream and record and record.installed
@overload
def traverse(
self,
*,
root: bool = ...,
order: spack.traverse.OrderType = ...,
cover: spack.traverse.CoverType = ...,
direction: spack.traverse.DirectionType = ...,
deptype: Union[dt.DepFlag, dt.DepTypes] = ...,
depth: Literal[False] = False,
key: Callable[["Spec"], Any] = ...,
visited: Optional[Set[Any]] = ...,
) -> Iterable["Spec"]: ...
@overload
def traverse(
self,
*,
root: bool = ...,
order: spack.traverse.OrderType = ...,
cover: spack.traverse.CoverType = ...,
direction: spack.traverse.DirectionType = ...,
deptype: Union[dt.DepFlag, dt.DepTypes] = ...,
depth: Literal[True],
key: Callable[["Spec"], Any] = ...,
visited: Optional[Set[Any]] = ...,
) -> Iterable[Tuple[int, "Spec"]]: ...
[docs]
def traverse(
self,
*,
root: bool = True,
order: spack.traverse.OrderType = "pre",
cover: spack.traverse.CoverType = "nodes",
direction: spack.traverse.DirectionType = "children",
deptype: Union[dt.DepFlag, dt.DepTypes] = "all",
depth: bool = False,
key: Callable[["Spec"], Any] = id,
visited: Optional[Set[Any]] = None,
) -> Iterable[Union["Spec", Tuple[int, "Spec"]]]:
"""Shorthand for :meth:`~spack.traverse.traverse_nodes`"""
return spack.traverse.traverse_nodes(
[self],
root=root,
order=order,
cover=cover,
direction=direction,
deptype=deptype,
depth=depth,
key=key,
visited=visited,
)
@overload
def traverse_edges(
self,
*,
root: bool = ...,
order: spack.traverse.OrderType = ...,
cover: spack.traverse.CoverType = ...,
direction: spack.traverse.DirectionType = ...,
deptype: Union[dt.DepFlag, dt.DepTypes] = ...,
depth: Literal[False] = False,
key: Callable[["Spec"], Any] = ...,
visited: Optional[Set[Any]] = ...,
) -> Iterable[DependencySpec]: ...
@overload
def traverse_edges(
self,
*,
root: bool = ...,
order: spack.traverse.OrderType = ...,
cover: spack.traverse.CoverType = ...,
direction: spack.traverse.DirectionType = ...,
deptype: Union[dt.DepFlag, dt.DepTypes] = ...,
depth: Literal[True],
key: Callable[["Spec"], Any] = ...,
visited: Optional[Set[Any]] = ...,
) -> Iterable[Tuple[int, DependencySpec]]: ...
[docs]
def traverse_edges(
self,
*,
root: bool = True,
order: spack.traverse.OrderType = "pre",
cover: spack.traverse.CoverType = "nodes",
direction: spack.traverse.DirectionType = "children",
deptype: Union[dt.DepFlag, dt.DepTypes] = "all",
depth: bool = False,
key: Callable[["Spec"], Any] = id,
visited: Optional[Set[Any]] = None,
) -> Iterable[Union[DependencySpec, Tuple[int, DependencySpec]]]:
"""Shorthand for :meth:`~spack.traverse.traverse_edges`"""
return spack.traverse.traverse_edges(
[self],
root=root,
order=order,
cover=cover,
direction=direction,
deptype=deptype,
depth=depth,
key=key,
visited=visited,
)
@property
def prefix(self) -> spack.util.prefix.Prefix:
if not self._concrete:
raise spack.error.SpecError(f"Spec is not concrete: {self}")
if self._prefix is None:
from spack.store import STORE
_, record = STORE.db.query_by_spec_hash(self.dag_hash())
if record and record.path:
self.set_prefix(record.path)
else:
self.set_prefix(STORE.layout.path_for_spec(self))
assert self._prefix is not None
return self._prefix
[docs]
def set_prefix(self, value: str) -> None:
self._prefix = spack.util.prefix.Prefix(spack.util.path.convert_to_platform_path(value))
[docs]
def spec_hash(self, hash: ht.SpecHashDescriptor) -> str:
"""Utility method for computing different types of Spec hashes.
Arguments:
hash: type of hash to generate.
"""
# TODO: currently we strip build dependencies by default. Rethink
# this when we move to using package hashing on all specs.
if hash.override is not None:
return hash.override(self)
node_dict = self.to_node_dict(hash=hash)
json_text = json.dumps(
node_dict, ensure_ascii=True, indent=None, separators=(",", ":"), sort_keys=False
)
# This implements "frankenhashes", preserving the last 7 characters of the
# original hash when splicing so that we can avoid relocation issues
out = spack.util.hash.b32_hash(json_text)
if self.build_spec is not self:
return out[:-7] + self.build_spec.spec_hash(hash)[-7:]
return out
def _cached_hash(
self, hash: ht.SpecHashDescriptor, length: Optional[int] = None, force: bool = False
) -> str:
"""Helper function for storing a cached hash on the spec.
This will run spec_hash() with the deptype and package_hash
parameters, and if this spec is concrete, it will store the value
in the supplied attribute on this spec.
Arguments:
hash: type of hash to generate.
length: length of hash prefix to return (default is full hash string)
force: cache the hash even if spec is not concrete (default False)
"""
hash_string = getattr(self, hash.attr, None)
if hash_string:
return hash_string[:length]
hash_string = self.spec_hash(hash)
if force or self.concrete:
setattr(self, hash.attr, hash_string)
return hash_string[:length]
[docs]
def dag_hash(self, length=None):
"""This is Spack's default hash, used to identify installations.
NOTE: Versions of Spack prior to 0.18 only included link and run deps.
NOTE: Versions of Spack prior to 1.0 only did not include test deps.
"""
return self._cached_hash(ht.dag_hash, length)
[docs]
def dag_hash_bit_prefix(self, bits):
"""Get the first <bits> bits of the DAG hash as an integer type."""
return spack.util.hash.base32_prefix_bits(self.dag_hash(), bits)
[docs]
def to_node_dict(self, hash: ht.SpecHashDescriptor = ht.dag_hash) -> Dict[str, Any]:
"""Create a dictionary representing the state of this Spec.
This method creates the content that is eventually hashed by Spack to create identifiers
like the DAG hash (see :meth:`dag_hash()`). Example result of this function for the
``sqlite`` package::
{
"name": "sqlite",
"version": "3.46.0",
"arch": {"platform": "linux", "platform_os": "ubuntu24.04", "target": "x86_64_v3"},
"namespace": "builtin",
"parameters": {
"build_system": "autotools",
"column_metadata": True,
"dynamic_extensions": True,
"fts": True,
"functions": False,
"rtree": True,
"cflags": [],
"cppflags": [],
"cxxflags": [],
"fflags": [],
"ldflags": [],
"ldlibs": [],
},
"package_hash": "umcghjlve5347o3q2odo7vfcso2zhxdzmfdba23nkdhe5jntlhia====",
"dependencies": [
{
"name": "compiler-wrapper",
"hash": "c5bxlim3zge4snwrwtd6rzuvq2unek6s",
"parameters": {"deptypes": ("build",), "virtuals": ()},
},
{
"name": "gcc",
"hash": "6dzveld2rtt2dkhklxfnery5wbtb5uus",
"parameters": {"deptypes": ("build",), "virtuals": ("c",)},
},
...
],
"annotations": {"original_specfile_version": 5},
}
Note that the dictionary returned does *not* include the hash of the *root* of the spec,
though it does include hashes for each dependency and its own package hash.
See :meth:`to_dict()` for a "complete" spec hash, with hashes for each node and nodes for
each dependency (instead of just their hashes).
Arguments:
hash: type of hash to generate.
"""
d: Dict[str, Any] = {"name": self.name}
if self.versions:
d.update(self.versions.to_dict())
if self.architecture:
d.update(self.architecture.to_dict())
if self.namespace:
d["namespace"] = self.namespace
params: Dict[str, Any] = dict(sorted(v.yaml_entry() for v in self.variants.values()))
# Only need the string compiler flag for yaml file
params.update(
sorted(
self.compiler_flags.yaml_entry(flag_type)
for flag_type in self.compiler_flags.keys()
)
)
if params:
d["parameters"] = params
if params and not self.concrete:
flag_names = [
name
for name, flags in self.compiler_flags.items()
if any(x.propagate for x in flags)
]
d["propagate"] = sorted(
itertools.chain(
[v.name for v in self.variants.values() if v.propagate], flag_names
)
)
d["abstract"] = sorted(v.name for v in self.variants.values() if not v.concrete)
if not self._concrete:
# State that only abstract specs have, or that "parameters" and "propagate" above are
# too coarse to express. Concrete node dicts are left alone: they feed the DAG hash.
if self.abstract_hash:
d["abstract_hash"] = self.abstract_hash
compiler_flags = self.compiler_flags.to_dict()
if compiler_flags:
d["compiler_flags"] = compiler_flags
if self.external:
d["external"] = {
"path": self.external_path,
"module": self.external_modules or None,
"extra_attributes": syaml.sorted_dict(self.extra_attributes),
}
if not self._concrete:
d["concrete"] = False
if "patches" in self.variants:
variant = self.variants["patches"]
if hasattr(variant, "_patches_in_order_of_appearance"):
d["patches"] = variant._patches_in_order_of_appearance
if (
self._concrete
and hash.package_hash
and hasattr(self, "_package_hash")
and self._package_hash
):
# The package hash is assigned at concretization time. We don't want to compute one for
# a concrete spec, where a) the package might not exist, or b) the `dag_hash` didn't
# include the package hash when the spec was concretized.
package_hash = self._package_hash
# Full hashes are in bytes
if not isinstance(package_hash, str) and isinstance(package_hash, bytes):
package_hash = package_hash.decode("utf-8")
d["package_hash"] = package_hash
# Note: Relies on sorting dict by keys later in algorithm.
deps = self._dependencies_dict(depflag=hash.depflag)
if deps:
dependencies = []
for name, edges_for_name in sorted(deps.items()):
for dspec in edges_for_name:
dep_attrs: Dict[str, Any] = {
"name": name,
hash.name: dspec.spec._cached_hash(hash),
"parameters": {
"deptypes": dt.flag_to_tuple(dspec.depflag),
"virtuals": dspec.virtuals,
},
}
if dspec.direct:
dep_attrs["parameters"]["direct"] = True
if not self._concrete:
if dspec.when != EMPTY_SPEC:
dep_attrs["parameters"]["when"] = str(dspec.when)
if dspec.propagation != PropagationPolicy.NONE:
dep_attrs["parameters"]["propagation"] = dspec.propagation.name
dependencies.append(dep_attrs)
d["dependencies"] = dependencies
# Name is included in case this is replacing a virtual.
if self._build_spec:
d["build_spec"] = {
"name": self.build_spec.name,
hash.name: self.build_spec._cached_hash(hash),
}
# Annotations
d["annotations"] = {"original_specfile_version": self.annotations.original_spec_format}
if self.annotations.original_spec_format < 5:
d["annotations"]["compiler"] = str(self.annotations.compiler_node_attribute)
return d
[docs]
def to_dict(self, hash: ht.SpecHashDescriptor = ht.dag_hash) -> Dict[str, Any]:
"""Create a dictionary suitable for writing this spec to YAML or JSON.
This dictionary is like the one that is ultimately written to a ``spec.json`` file in each
Spack installation directory. For example, for sqlite::
{
"spec": {
"_meta": {"version": 5},
"nodes": [
{
"name": "sqlite",
"version": "3.46.0",
"arch": {
"platform": "linux",
"platform_os": "ubuntu24.04",
"target": "x86_64_v3"
},
"namespace": "builtin",
"parameters": {
"build_system": "autotools",
"column_metadata": True,
"dynamic_extensions": True,
"fts": True,
"functions": False,
"rtree": True,
"cflags": [],
"cppflags": [],
"cxxflags": [],
"fflags": [],
"ldflags": [],
"ldlibs": [],
},
"package_hash": "umcghjlve5347o...xdzmfdba23nkdhe5jntlhia====",
"dependencies": [
{
"name": "compiler-wrapper",
"hash": "c5bxlim3zge4snwrwtd6rzuvq2unek6s",
"parameters": {"deptypes": ("build",), "virtuals": ()},
},
{
"name": "gcc",
"hash": "6dzveld2rtt2dkhklxfnery5wbtb5uus",
"parameters": {"deptypes": ("build",), "virtuals": ("c",)},
},
...
],
"annotations": {"original_specfile_version": 5},
"hash": "a2ubvvqnula6zdppckwqrjf3zmsdzpoh",
},
...
],
}
}
Note that this dictionary starts with the ``spec`` key, and what follows is a list starting
with the root spec, followed by its dependencies in preorder.
The method :meth:`from_dict()` can be used to read back in a spec that has been converted
to a dictionary, serialized, and read back in.
"""
node_list = [] # Using a list to preserve preorder traversal for hash.
hash_set = set()
for s in self.traverse(order="pre", deptype=hash.depflag):
spec_hash = s._cached_hash(hash)
if spec_hash not in hash_set:
node_list.append(s.node_dict_with_hashes(hash))
hash_set.add(spec_hash)
if s.build_spec is not s:
build_spec_list = s.build_spec.to_dict(hash)["spec"]["nodes"]
for node in build_spec_list:
node_hash = node[hash.name]
if node_hash not in hash_set:
node_list.append(node)
hash_set.add(node_hash)
return {"spec": {"_meta": {"version": SPECFILE_FORMAT_VERSION}, "nodes": node_list}}
[docs]
def node_dict_with_hashes(self, hash: ht.SpecHashDescriptor = ht.dag_hash) -> Dict[str, Any]:
"""Returns a dict of this spec with the dag hash, and optionally another hash or id.
Arguments:
hash: Optional other hash to include. If this is the dag hash, it's only included once.
"""
node = self.to_node_dict(hash)
# All specs have at least a DAG hash
node[ht.dag_hash.name] = self.dag_hash()
if not self.concrete:
node["concrete"] = False
# we can also give them other hash types if we want
if hash.name != ht.dag_hash.name:
node[hash.name] = self._cached_hash(hash)
return node
[docs]
def to_yaml(self, stream=None, hash=ht.dag_hash):
return syaml.dump(self.to_dict(hash), stream=stream, default_flow_style=False)
[docs]
def to_json(self, stream=None, *, hash=ht.dag_hash, pretty=False):
if stream is None:
return sjson.dumps(self.to_dict(hash), pretty=pretty)
sjson.dump(self.to_dict(hash), stream, pretty=pretty)
return None
[docs]
@staticmethod
def from_specfile(path):
"""Construct a spec from a JSON or YAML spec file path"""
with open(path, "r", encoding="utf-8") as fd:
file_content = fd.read()
if path.endswith(".json"):
return Spec.from_json(file_content)
return Spec.from_yaml(file_content)
[docs]
@staticmethod
def override(init_spec, change_spec):
# TODO: this doesn't account for the case where the changed spec
# (and the user spec) have dependencies
new_spec = init_spec.copy()
package_cls = spack.repo.PATH.get_pkg_class(new_spec.name)
if change_spec.versions and not change_spec.versions == vn.any_version:
new_spec.versions = change_spec.versions
for vname, value in change_spec.variants.items():
if vname in package_cls.variant_names():
if vname in new_spec.variants:
new_spec.variants.substitute(value)
else:
new_spec.variants[vname] = value
else:
raise ValueError("{0} is not a variant of {1}".format(vname, new_spec.name))
if change_spec.compiler_flags:
for flagname, flagvals in change_spec.compiler_flags.items():
new_spec.compiler_flags[flagname] = flagvals
if change_spec.architecture:
new_spec.architecture = ArchSpec.override(
new_spec.architecture, change_spec.architecture
)
return new_spec
[docs]
@staticmethod
def from_literal(spec_dict: dict, normal: bool = True) -> "Spec":
"""Builds a Spec from a dictionary containing the spec literal.
The dictionary must have a single top level key, representing the root,
and as many secondary level keys as needed in the spec.
The keys can be either a string or a Spec or a tuple containing the
Spec and the dependency types.
Args:
spec_dict: the dictionary containing the spec literal
normal: if :data:`True` the same key appearing at different levels
of the ``spec_dict`` will map to the same object in memory.
Examples:
A simple spec ``foo`` with no dependencies::
{"foo": None}
A spec ``foo`` with a ``(build, link)`` dependency ``bar``::
{"foo":
{"bar:build,link": None}
}
A spec with a diamond dependency and various build types::
{"dt-diamond": {
"dt-diamond-left:build,link": {
"dt-diamond-bottom:build": None
},
"dt-diamond-right:build,link": {
"dt-diamond-bottom:build,link,run": None
}
}}
The same spec with a double copy of ``dt-diamond-bottom`` and
no diamond structure::
Spec.from_literal({"dt-diamond": {
"dt-diamond-left:build,link": {
"dt-diamond-bottom:build": None
},
"dt-diamond-right:build,link": {
"dt-diamond-bottom:build,link,run": None
}
}, normal=False}
Constructing a spec using a Spec object as key::
mpich = Spec("mpich")
libelf = Spec("libelf@1.8.11")
expected_normalized = Spec.from_literal({
"mpileaks": {
"callpath": {
"dyninst": {
"libdwarf": {libelf: None},
libelf: None
},
mpich: None
},
mpich: None
},
})
"""
# Maps a literal to a Spec, to be sure we are reusing the same object
spec_cache = LazySpecCache()
def spec_builder(d):
# The invariant is that the top level dictionary must have
# only one key
assert len(d) == 1
# Construct the top-level spec
spec_like, dep_like = next(iter(d.items()))
# If the requirements was for unique nodes (default)
# then reuse keys from the local cache. Otherwise build
# a new node every time.
if not isinstance(spec_like, Spec):
spec = spec_cache[spec_like] if normal else Spec(spec_like)
else:
spec = spec_like
if dep_like is None:
return spec
def name_and_dependency_types(s: str) -> Tuple[str, dt.DepFlag]:
"""Given a key in the dictionary containing the literal,
extracts the name of the spec and its dependency types.
Args:
s: key in the dictionary containing the literal
"""
t = s.split(":")
if len(t) > 2:
msg = 'more than one ":" separator in key "{0}"'
raise KeyError(msg.format(s))
name = t[0]
if len(t) == 2:
depflag = dt.flag_from_strings(dep_str.strip() for dep_str in t[1].split(","))
else:
depflag = 0
return name, depflag
def spec_and_dependency_types(
s: Union[Spec, Tuple[Spec, str]],
) -> Tuple[Spec, dt.DepFlag]:
"""Given a non-string key in the literal, extracts the spec
and its dependency types.
Args:
s: either a Spec object, or a tuple of Spec and string of dependency types
"""
if isinstance(s, Spec):
return s, 0
spec_obj, dtypes = s
return spec_obj, dt.flag_from_strings(dt.strip() for dt in dtypes.split(","))
# Recurse on dependencies
for s, s_dependencies in dep_like.items():
if isinstance(s, str):
dag_node, dep_flag = name_and_dependency_types(s)
else:
dag_node, dep_flag = spec_and_dependency_types(s)
dependency_spec = spec_builder({dag_node: s_dependencies})
spec._add_dependency(dependency_spec, depflag=dep_flag, virtuals=())
return spec
return spec_builder(spec_dict)
[docs]
@staticmethod
def from_dict(data) -> "Spec":
"""Construct a spec from JSON/YAML.
Args:
data: a nested dict/list data structure read from YAML or JSON.
"""
# Figure out the specfile format
if isinstance(data["spec"], list):
version = 1
else:
version = int(data["spec"]["_meta"]["version"])
# get the right reader
reader = specfile_reader_for_version(version)
spec = reader.load(data)
# Handle git versions
for s in spec.traverse():
s.attach_git_version_lookup()
return spec
[docs]
@staticmethod
def from_yaml(stream) -> "Spec":
"""Construct a spec from YAML.
Args:
stream: string or file object to read from.
"""
data = syaml.load(stream)
return Spec.from_dict(data)
[docs]
@staticmethod
def from_json(stream) -> "Spec":
"""Construct a spec from JSON.
Args:
stream: string or file object to read from.
"""
try:
data = sjson.load(stream)
return Spec.from_dict(data)
except Exception as e:
raise sjson.SpackJSONError("error parsing JSON spec:", e) from e
[docs]
@staticmethod
def from_signed_json(stream):
"""Construct a spec from clearsigned json spec file.
Args:
stream: string or file object to read from.
"""
data = stream
if hasattr(stream, "read"):
data = stream.read()
extracted_json = spack.util.gpg.extract_json_from_clearsig(data)
return Spec.from_dict(extracted_json)
[docs]
@staticmethod
def from_detection(
spec_str: str,
*,
external_path: str,
external_modules: Optional[List[str]] = None,
extra_attributes: Optional[Dict] = None,
) -> "Spec":
"""Construct a spec from a spec string determined during external
detection and attach extra attributes to it.
Args:
spec_str: spec string
external_path: prefix of the external spec
external_modules: optional module files to be loaded when the external spec is used
extra_attributes: dictionary containing extra attributes
"""
s = Spec(spec_str, external_path=external_path, external_modules=external_modules)
extra_attributes = syaml.sorted_dict(extra_attributes or {})
# This is needed to be able to validate multi-valued variants,
# otherwise they'll still be abstract in the context of detection.
substitute_abstract_variants(s)
s.extra_attributes = extra_attributes
return s
def _patches_assigned(self):
"""Whether patches have been assigned to this spec by the concretizer."""
# FIXME: _patches_in_order_of_appearance is attached after concretization
# FIXME: to store the order of patches.
# FIXME: Probably needs to be refactored in a cleaner way.
if "patches" not in self.variants:
return False
# ensure that patch state is consistent
patch_variant = self.variants["patches"]
assert hasattr(patch_variant, "_patches_in_order_of_appearance"), (
"patches should always be assigned with a patch variant."
)
return True
def _mark_root_concrete(self, value=True):
"""Mark just this spec (not dependencies) concrete."""
if self._concrete == value:
return
self._concrete = value
# A direct dependency is a constraint written with %, so the flag belongs on abstract
# specs only; every edge of a materialized DAG is one anyway.
for edge in self.edges_to_dependencies():
edge.direct = not value
if value:
self._validate_version()
for variant in self.variants.values():
variant.concrete = True
def _validate_version(self):
# Specs that were concretized with just a git sha as version, without associated
# Spack version, get their Spack version mapped to develop. This should only apply
# when reading specs concretized with Spack 0.19 or earlier. Currently Spack always
# ensures that GitVersion specs have an associated Spack version.
v = self.versions.concrete
if not isinstance(v, vn.GitVersion):
return
try:
v.ref_version
except vn.VersionLookupError:
before = self.cformat("{name}{@version}{/hash:7}")
v.std_version = vn.StandardVersion.from_string("develop")
tty.debug(
f"the git sha of {before} could not be resolved to spack version; "
f"it has been replaced by {self.cformat('{name}{@version}{/hash:7}')}."
)
def _mark_concrete(self, value=True):
"""Mark this spec and its dependencies as concrete.
Only for internal use -- client code should use "concretize"
unless there is a need to force a spec to be concrete.
"""
# if set to false, clear out all hashes (set to None or remove attr)
# may need to change references to respect None
for s in self.traverse():
if not value:
s.clear_caches()
s._mark_root_concrete(value)
def _finalize_concretization(self):
"""Assign hashes to this spec, and mark it concrete.
There are special semantics to consider for ``package_hash``, because we can't
call it on *already* concrete specs, but we need to assign it *at concretization
time* to just-concretized specs. So, the concretizer must assign the package
hash *before* marking their specs concrete (so that we know which specs were
already concrete before this latest concretization).
``dag_hash`` is also tricky, since it cannot compute ``package_hash()`` lazily.
Because ``package_hash`` needs to be assigned *at concretization time*,
``to_node_dict()`` can't just assume that it can compute ``package_hash`` itself
-- it needs to either see or not see a ``_package_hash`` attribute.
Rules of thumb for ``package_hash``:
1. Old-style concrete specs from *before* ``dag_hash`` included ``package_hash``
will not have a ``_package_hash`` attribute at all.
2. New-style concrete specs will have a ``_package_hash`` assigned at
concretization time.
3. Abstract specs will not have a ``_package_hash`` attribute at all.
"""
for spec in self.traverse():
# Already concrete specs either already have a package hash (new dag_hash())
# or they never will b/c we can't know it (old dag_hash()). Skip them.
#
# We only assign package hash to not-yet-concrete specs, for which we know
# we can compute the hash.
if not spec.concrete:
# we need force=True here because package hash assignment has to happen
# before we mark concrete, so that we know what was *already* concrete.
spec._cached_hash(ht.package_hash, force=True)
# keep this check here to ensure package hash is saved
assert getattr(spec, ht.package_hash.attr)
# Mark everything in the spec as concrete
self._mark_concrete()
# Assign dag_hash (this *could* be done lazily, but it's assigned anyway in
# ensure_no_deprecated, and it's clearer to see explicitly where it happens).
# Any specs that were concrete before finalization will already have a cached
# DAG hash.
for spec in self.traverse():
spec._cached_hash(ht.dag_hash)
[docs]
def index(self, deptype="all"):
"""Return a dictionary that points to all the dependencies in this
spec.
"""
dm = collections.defaultdict(list)
for spec in self.traverse(deptype=deptype):
dm[spec.name].append(spec)
return dm
[docs]
def validate_or_raise(self):
"""Checks that names and values in this spec are real. If they're not,
it will raise an appropriate exception.
"""
# FIXME: this function should be lazy, and collect all the errors
# FIXME: before raising the exceptions, instead of being greedy and
# FIXME: raise just the first one encountered
for spec in self.traverse():
# raise an UnknownPackageError if the spec's package isn't real.
if spec.name and not spack.repo.PATH.is_virtual(spec.name):
spack.repo.PATH.get_pkg_class(spec.fullname)
# FIXME: atm allow '%' on abstract specs only if they depend on C, C++, or Fortran
if spec.dependencies(deptype="build"):
pkg_cls = spack.repo.PATH.get_pkg_class(spec.fullname)
pkg_dependencies = pkg_cls.dependency_names()
if not any(x in pkg_dependencies for x in ("c", "cxx", "fortran")):
raise UnsupportedCompilerError(
f"{spec.fullname} does not depend on 'c', 'cxx, or 'fortran'"
)
# Ensure correctness of variants (if the spec is not virtual)
if not spack.repo.PATH.is_virtual(spec.name):
Spec.ensure_valid_variants(spec)
substitute_abstract_variants(spec)
[docs]
@staticmethod
def ensure_valid_variants(spec: "Spec") -> None:
"""Ensures that the variant attached to the given spec are valid.
Raises:
spack.variant.UnknownVariantError: on the first unknown variant found
"""
# concrete variants are always valid
if spec.concrete:
return
pkg_cls = spack.repo.PATH.get_pkg_class(spec.fullname)
pkg_variants = pkg_cls.variant_names()
# reserved names are variants that may be set on any package
# but are not necessarily recorded by the package's class
propagate_variants = [name for name, variant in spec.variants.items() if variant.propagate]
not_existing = set(spec.variants)
not_existing.difference_update(pkg_variants, vt.RESERVED_NAMES, propagate_variants)
if not_existing:
raise vt.UnknownVariantError(
f"No such variant {not_existing} for spec: '{spec}'", list(not_existing)
)
[docs]
def constrain(self, other, deps=True) -> bool:
"""Constrains self with other, and returns True if self changed, False otherwise.
Args:
other: constraint to be added to self
deps: if False, constrain only the root node, otherwise constrain dependencies as well
Raises:
spack.error.UnsatisfiableSpecError: when self cannot be constrained
"""
return self._constrain(other, deps=deps, resolve_virtuals=True)
def _constrain_symbolically(self, other, deps=True) -> bool:
"""Constrains self with other, and returns True if self changed, False otherwise.
This function has no notion of virtuals, so it does not need a repository.
Args:
other: constraint to be added to self
deps: if False, constrain only the root node, otherwise constrain dependencies as well
Raises:
spack.error.UnsatisfiableSpecError: when self cannot be constrained
Examples:
>>> from spack.spec import Spec, UnsatisfiableDependencySpecError
>>> s = Spec("hdf5 ^mpi@4")
>>> t = Spec("hdf5 ^mpi=openmpi")
>>> try:
... s.constrain(t)
... except UnsatisfiableDependencySpecError as e:
... print(e)
...
hdf5 ^mpi=openmpi does not satisfy hdf5 ^mpi@4
>>> s._constrain_symbolically(t)
True
>>> s
hdf5 ^mpi@4 ^mpi=openmpi
"""
return self._constrain(other, deps=deps, resolve_virtuals=False)
def _constrain(self, other, deps=True, *, resolve_virtuals: bool):
# If we are trying to constrain a concrete spec, either the spec
# already satisfies the constraint (and the method returns False)
# or it raises an exception
if self.concrete:
if self._satisfies(other, resolve_virtuals=resolve_virtuals):
return False
else:
raise spack.error.UnsatisfiableSpecError(self, other, "constrain a concrete spec")
other = self._autospec(other)
if other.concrete and other._satisfies(self, resolve_virtuals=resolve_virtuals):
# _dup makes self a detached copy without in-edges; self stays a node in its
# dependents' edge maps, so keep them
dependents = self._dependents
self._dup(other)
self._dependents = dependents
return True
if not (self.name == other.name or (not self.name) or (not other.name)):
raise UnsatisfiableSpecNameError(self.name, other.name)
if (
other.namespace is not None
and self.namespace is not None
and other.namespace != self.namespace
):
raise UnsatisfiableSpecNameError(self.fullname, other.fullname)
if not self.versions.overlaps(other.versions):
raise UnsatisfiableVersionSpecError(self.versions, other.versions)
for v in [x for x in other.variants if x in self.variants]:
if not self.variants[v].intersects(other.variants[v]):
raise vt.UnsatisfiableVariantSpecError(self.variants[v], other.variants[v])
sarch, oarch = self.architecture, other.architecture
if (
sarch is not None
and oarch is not None
and not self.architecture.intersects(other.architecture)
):
raise UnsatisfiableArchitectureSpecError(sarch, oarch)
changed = False
if other.abstract_hash:
if not self.abstract_hash or other.abstract_hash.startswith(self.abstract_hash):
changed |= self.abstract_hash != other.abstract_hash
self.abstract_hash = other.abstract_hash
elif not self.abstract_hash.startswith(other.abstract_hash):
raise InvalidHashError(self, other.abstract_hash)
if not self.name and other.name:
self.name = other.name
changed = True
# The children's dependent edges are filed under the name self had when they were
# added, the anonymous one: move them to the new name.
for edge in self.edges_to_dependencies():
dependents = edge.spec._dependents
remaining = [e for e in dependents[""] if e is not edge]
if remaining:
dependents[""] = remaining
else:
del dependents[""]
_add_edge_to_map(dependents, self.name, edge)
if not self.namespace and other.namespace:
self.namespace = other.namespace
changed = True
changed |= self.versions.intersect(other.versions)
changed |= self._constrain_variants(other)
changed |= self.compiler_flags.constrain(other.compiler_flags)
sarch, oarch = self.architecture, other.architecture
if sarch is not None and oarch is not None:
changed |= self.architecture.constrain(other.architecture)
elif oarch is not None:
# copy, so that a later constrain on self does not write through into other
self.architecture = oarch.copy()
changed = True
if deps:
changed |= self._constrain_dependencies(other, resolve_virtuals=resolve_virtuals)
return changed
def _constrain_dependencies(self, other: "Spec", resolve_virtuals: bool = True) -> bool:
"""Apply constraints of other spec's dependencies to this spec."""
if not other._dependencies:
return False
# TODO: might want more detail than this, e.g. specific deps
# in violation. if this becomes a priority get rid of this
# check and be more specific about what's wrong.
if not other._intersects_dependencies(self, resolve_virtuals=resolve_virtuals):
raise UnsatisfiableDependencySpecError(other, self)
changed = False
for other_edge in other.edges_to_dependencies():
candidate = DependencySpec(
self,
other_edge.spec,
depflag=other_edge.depflag,
virtuals=other_edge.virtuals,
direct=other_edge.direct,
propagation=other_edge.propagation,
when=other_edge.when, # no need to copy; when conditions are immutable
)
changed |= self._add_or_merge_edge(
candidate, owned=False, resolve_virtuals=resolve_virtuals
)
return changed
[docs]
def constrained(self, other, deps=True):
"""Return a constrained copy without modifying this spec."""
clone = self.copy(deps=deps)
clone.constrain(other, deps)
return clone
def _autospec(self, spec_like):
"""
Used to convert arguments to specs. If spec_like is a spec, returns
it. If it's a string, tries to parse a string. If that fails, tries
to parse a local spec from it (i.e. name is assumed to be self's name).
"""
if isinstance(spec_like, Spec):
return spec_like
return Spec(spec_like)
[docs]
def intersects(self, other: Union[str, "Spec"], deps: bool = True) -> bool:
"""Return True if there exists at least one concrete spec that matches both
self and other, otherwise False.
This operation is commutative, and if two specs intersect it means that one
can constrain the other.
Args:
other: spec to be checked for compatibility
deps: if True check compatibility of dependency nodes too, if False only check root
"""
return self._intersects(other=other, deps=deps, resolve_virtuals=True)
def _intersects(
self, other: Union[str, "Spec"], deps: bool = True, resolve_virtuals: bool = True
) -> bool:
if other is EMPTY_SPEC:
return True
other = self._autospec(other)
if other.concrete and self.concrete:
return self.dag_hash() == other.dag_hash()
elif self.concrete:
return self._satisfies(other, resolve_virtuals=resolve_virtuals)
elif other.concrete:
return other._satisfies(self, resolve_virtuals=resolve_virtuals)
# From here we know both self and other are not concrete
self_hash = self.abstract_hash
other_hash = other.abstract_hash
if (
self_hash
and other_hash
and not (self_hash.startswith(other_hash) or other_hash.startswith(self_hash))
):
return False
# If the names are different, we need to consider virtuals
if self.name != other.name and self.name and other.name:
if not resolve_virtuals:
return False
self_virtual = spack.repo.PATH.is_virtual(self.name)
other_virtual = spack.repo.PATH.is_virtual(other.name)
if self_virtual and other_virtual:
# Two virtual specs intersect only if there are providers for both
lhs = spack.repo.PATH.providers_for(str(self))
rhs = spack.repo.PATH.providers_for(str(other))
intersection = [s for s in lhs if any(s.intersects(z) for z in rhs)]
return bool(intersection)
# A provider can satisfy a virtual dependency.
elif self_virtual or other_virtual:
virtual_spec, non_virtual_spec = (self, other) if self_virtual else (other, self)
try:
# Here we might get an abstract spec
pkg_cls = spack.repo.PATH.get_pkg_class(non_virtual_spec.fullname)
pkg = pkg_cls(non_virtual_spec)
except spack.repo.UnknownEntityError:
# If we can't get package info on this spec, don't treat
# it as a provider of this vdep.
return False
if pkg.provides(virtual_spec.name):
for when_spec, provided in pkg.provided.items():
if non_virtual_spec.intersects(when_spec, deps=False):
if any(vpkg.intersects(virtual_spec) for vpkg in provided):
return True
return False
# namespaces either match, or other doesn't require one.
if (
other.namespace is not None
and self.namespace is not None
and self.namespace != other.namespace
):
return False
if self.versions and other.versions:
if not self.versions.intersects(other.versions):
return False
if not self._intersects_variants(other):
return False
if self.architecture and other.architecture:
if not self.architecture.intersects(other.architecture):
return False
if not self.compiler_flags.intersects(other.compiler_flags):
return False
# If we need to descend into dependencies, do it, otherwise we're done.
if deps:
return self._intersects_dependencies(other, resolve_virtuals=resolve_virtuals)
return True
def _intersects_dependencies(self, other, resolve_virtuals: bool = True):
if not other._dependencies or not self._dependencies:
# one spec *could* eventually satisfy the other
return True
# A package has at most one direct dependency per name, so a concretization satisfies
# all unconditional direct edges to one name with a single node. Transitive constraints
# to one name never conflict with each other: a DAG can hold two nodes of the same name.
groups: Dict[str, List[DependencySpec]] = {}
for edge in itertools.chain(self.edges_to_dependencies(), other.edges_to_dependencies()):
if edge.direct and edge.spec.name and edge.when is EMPTY_SPEC:
groups.setdefault(edge.spec.name, []).append(edge)
for edges in groups.values():
if len(edges) < 2:
continue
# A concrete node admits no further constraining: the group merges iff the concrete
# spec satisfies every other edge, so no copy of its subdag is needed.
concrete = next((e.spec for e in edges if e.spec.concrete), None)
if concrete is not None:
if all(
concrete._satisfies(e.spec, resolve_virtuals=resolve_virtuals)
for e in edges
if e.spec is not concrete
):
continue
return False
merged = edges[0].spec.copy(deps=True)
try:
for edge in edges[1:]:
merged._constrain(edge.spec, resolve_virtuals=resolve_virtuals)
except spack.error.SpecError:
return False
if not resolve_virtuals:
return True
# For virtual dependencies, we need to dig a little deeper.
self_index = spack.provider_index.ProviderIndex(
repository=spack.repo.PATH, specs=self.traverse(), restrict=True
)
other_index = spack.provider_index.ProviderIndex(
repository=spack.repo.PATH, specs=other.traverse(), restrict=True
)
# These two loops handle cases where there is an overly restrictive
# vpkg in one spec for a provider in the other (e.g., mpi@3: is not
# compatible with mpich2)
for spec in self.traverse():
if (
spack.repo.PATH.is_virtual(spec.name)
and spec.name in other_index
and not other_index.providers_for(spec)
):
return False
for spec in other.traverse():
if (
spack.repo.PATH.is_virtual(spec.name)
and spec.name in self_index
and not self_index.providers_for(spec)
):
return False
return True
[docs]
def satisfies(self, other: Union[str, "Spec"], deps: bool = True) -> bool:
"""Return True if all concrete specs matching self also match other, otherwise False.
Args:
other: spec to be satisfied
deps: if True, descend to dependencies, otherwise only check root node
"""
return self._satisfies(other=other, deps=deps, resolve_virtuals=True)
def _provides_virtual(self, virtual_spec: "Spec") -> bool:
"""Return True if this spec provides the given virtual spec.
Args:
virtual_spec: abstract virtual spec (e.g. ``"mpi"`` or ``"mpi@3:"``)
"""
if not virtual_spec.name:
return False
# Get the package instance
if self.concrete:
try:
pkg = self.package
except spack.repo.UnknownPackageError:
return False
else:
try:
pkg_cls = spack.repo.PATH.get_pkg_class(self.fullname)
pkg = pkg_cls(self)
except spack.repo.UnknownEntityError:
# If we can't get package info on this spec, don't treat
# it as a provider of this vdep.
return False
for when_spec, provided in pkg.provided.items():
# Don't use satisfies for virtuals, because an abstract vs. abstract spec may use the
# repo index
if self.satisfies(when_spec, deps=False) and any(
provided_virtual.name == virtual_spec.name
and provided_virtual.versions.intersects(virtual_spec.versions)
for provided_virtual in provided
):
return True
return False
def _satisfies(
self, other: Union[str, "Spec"], deps: bool = True, resolve_virtuals: bool = True
) -> bool:
"""Return True if all concrete specs matching self also match other, otherwise False.
Args:
other: spec to be satisfied
deps: if True, descend to dependencies, otherwise only check root node
resolve_virtuals: if True, resolve virtuals in self and other. This requires a
repository to be available.
"""
if other is EMPTY_SPEC:
return True
other = self._autospec(other)
if not self._satisfies_node(other, resolve_virtuals=resolve_virtuals):
return False
# If there are no dependencies on the rhs, or we don't recurse, they are satisfied.
if not deps or not other._dependencies:
return True
return _satisfies_dependencies(self, other, resolve_virtuals=resolve_virtuals)
def _satisfies_node(self, other: "Spec", resolve_virtuals: bool) -> bool:
"""Compares self and other without looking at dependencies"""
if other.concrete:
# The left-hand side must be the same singleton with identical hash. Notice that
# package hashes can be different for otherwise indistinguishable concrete Spec
# objects.
return self.concrete and self.dag_hash() == other.dag_hash()
if other.name and not self.name:
return False
if self.name != other.name and self.name and other.name:
# Name mismatch can still be satisfiable if lhs provides the virtual mentioned by rhs.
if not resolve_virtuals:
return False
return self._provides_virtual(other)
# If the right-hand side has an abstract hash, make sure it's a prefix of the
# left-hand side's (abstract) hash.
if other.abstract_hash:
compare_hash = self.dag_hash() if self.concrete else self.abstract_hash
if not compare_hash or not compare_hash.startswith(other.abstract_hash):
return False
if other.namespace is not None and self.namespace != other.namespace:
return False
if not self.versions.satisfies(other.versions):
return False
if not self._satisfies_variants(other):
return False
if self.architecture and other.architecture:
if not self.architecture.satisfies(other.architecture):
return False
elif other.architecture and not self.architecture:
return False
if not self.compiler_flags.satisfies(other.compiler_flags):
return False
return True
def _satisfies_variants(self, other: "Spec") -> bool:
if self.concrete:
return self._satisfies_variants_when_self_concrete(other)
return self._satisfies_variants_when_self_abstract(other)
def _satisfies_variants_when_self_concrete(self, other: "Spec") -> bool:
non_propagating, propagating = other.variants.partition_variants()
result = all(
name in self.variants and self.variants[name].satisfies(other.variants[name])
for name in non_propagating
)
if not propagating:
return result
for node in self.traverse():
if not all(
node.variants[name].satisfies(other.variants[name])
for name in propagating
if name in node.variants
):
return False
return result
def _satisfies_variants_when_self_abstract(self, other: "Spec") -> bool:
other_non_propagating, other_propagating = other.variants.partition_variants()
self_non_propagating, self_propagating = self.variants.partition_variants()
# First check variants without propagation set
result = all(
name in self_non_propagating
and (
self.variants[name].propagate
or self.variants[name].satisfies(other.variants[name])
)
for name in other_non_propagating
)
if result is False or (not other_propagating and not self_propagating):
return result
# Check that self doesn't contradict variants propagated by other
if other_propagating:
for node in self.traverse():
if not all(
node.variants[name].satisfies(other.variants[name])
for name in other_propagating
if name in node.variants
):
return False
# Check that other doesn't contradict variants propagated by self
if self_propagating:
for node in other.traverse():
if not all(
node.variants[name].satisfies(self.variants[name])
for name in self_propagating
if name in node.variants
):
return False
return result
def _intersects_variants(self, other: "Spec") -> bool:
self_dict = self.variants.dict
other_dict = other.variants.dict
return all(self_dict[k].intersects(other_dict[k]) for k in other_dict if k in self_dict)
def _constrain_variants(self, other: "Spec") -> bool:
"""Add all variants in other that aren't in self to self. Also constrain all multi-valued
variants that are already present. Return True iff self changed"""
if other is not None and other._concrete:
for k in self.variants:
if k not in other.variants:
raise vt.UnsatisfiableVariantSpecError(self.variants[k], "<absent>")
changed = False
for k in other.variants:
if k in self.variants:
if not self.variants[k].intersects(other.variants[k]):
raise vt.UnsatisfiableVariantSpecError(self.variants[k], other.variants[k])
# If they are compatible merge them
changed |= self.variants[k].constrain(other.variants[k])
else:
# If it is not present copy it straight away
self.variants[k] = other.variants[k].copy()
changed = True
return changed
@property # type: ignore[misc] # decorated prop not supported in mypy
def patches(self):
"""Return patch objects for any patch sha256 sums on this Spec.
This is for use after concretization to iterate over any patches
associated with this spec.
TODO: this only checks in the package; it doesn't resurrect old
patches from install directories, but it probably should.
"""
if not hasattr(self, "_patches"):
self._patches = []
# translate patch sha256sums to patch objects by consulting the index
if self._patches_assigned():
sha256s = list(self.variants["patches"]._patches_in_order_of_appearance)
pkg_cls = spack.repo.PATH.get_pkg_class(self.fullname)
try:
self._patches = spack.repo.PATH.get_patches_for_package(sha256s, pkg_cls)
except spack.error.PatchLookupError as e:
raise spack.error.SpecError(
f"{e}. This may mean the patch was modified or removed. "
"To fix this, try: "
"(1) reconcretizing, "
"(2) clearing the cache with `spack clean -m`, or "
"(3) resetting the package repository."
) from e
return self._patches
def _dup(
self,
other: "Spec",
deps: Union[bool, dt.DepTypes, dt.DepFlag] = True,
*,
propagation: Optional[PropagationPolicy] = None,
) -> None:
"""Copies "other" into self, by overwriting all attributes.
Args:
other: spec to be copied onto ``self``
deps: if True copies all the dependencies. If False copies None.
If deptype, or depflag, copy matching types.
"""
self._package = None
# Local node attributes get copied first.
self.name = other.name
self.versions = other.versions.copy()
self.architecture = other.architecture.copy() if other.architecture else None
self.compiler_flags = other.compiler_flags.copy()
self.variants = other.variants.copy()
self._build_spec = other._build_spec
# Clear dependencies
self._dependents = {}
self._dependencies = {}
# FIXME: we manage _patches_in_order_of_appearance specially here
# to keep it from leaking out of spec.py, but we should figure
# out how to handle it more elegantly in the Variant classes.
for k, v in other.variants.items():
patches = getattr(v, "_patches_in_order_of_appearance", None)
if patches:
self.variants[k]._patches_in_order_of_appearance = patches
self.external_path = other.external_path
self.external_modules = other.external_modules
self.extra_attributes = other.extra_attributes
self.namespace = other.namespace
self.annotations = other.annotations
# If we copy dependencies, preserve DAG structure in the new spec
if deps:
# If caller restricted deptypes to be copied, adjust that here.
# By default, just copy all deptypes
depflag = dt.ALL
if isinstance(deps, (tuple, list, str)):
depflag = dt.canonicalize(deps)
self._dup_deps(other, depflag, propagation=propagation)
self._prefix = other._prefix
self._concrete = other._concrete
self.abstract_hash = other.abstract_hash
if self._concrete:
self._dunder_hash = other._dunder_hash
for h in ht.HASHES:
setattr(self, h.attr, getattr(other, h.attr, None))
else:
self._dunder_hash = None
for h in ht.HASHES:
setattr(self, h.attr, None)
def _dup_deps(
self, other, depflag: dt.DepFlag, propagation: Optional[PropagationPolicy] = None
):
def spid(spec):
return id(spec)
new_specs = {spid(other): self}
for edge in other.traverse_edges(cover="edges", root=False):
if edge.depflag and not depflag & edge.depflag:
continue
if spid(edge.parent) not in new_specs:
new_specs[spid(edge.parent)] = edge.parent.copy(deps=False)
if spid(edge.spec) not in new_specs:
new_specs[spid(edge.spec)] = edge.spec.copy(deps=False)
edge_propagation = edge.propagation if propagation is None else propagation
new_parent = new_specs[spid(edge.parent)]
new_child = new_specs[spid(edge.spec)]
new_edge = DependencySpec(
new_parent,
new_child,
depflag=edge.depflag,
virtuals=edge.virtuals,
propagation=edge_propagation,
direct=edge.direct,
when=edge.when,
)
# Don't use add_dependency_edge here, copy edges verbatim
_add_edge_to_map(new_parent._dependencies, new_child.name, new_edge)
_add_edge_to_map(new_child._dependents, new_parent.name, new_edge)
[docs]
def copy(self, deps: Union[bool, dt.DepTypes, dt.DepFlag] = True, **kwargs):
"""Make a copy of this spec.
Args:
deps: Defaults to :data:`True`. If boolean, controls
whether dependencies are copied (copied if :data:`True`). If a
DepTypes or DepFlag is provided, *only* matching dependencies are copied.
kwargs: additional arguments for internal use (passed to ``_dup``).
Returns:
A copy of this spec.
Examples:
Deep copy with dependencies::
spec.copy()
spec.copy(deps=True)
Shallow copy (no dependencies)::
spec.copy(deps=False)
Only build and run dependencies::
deps=("build", "run"):
"""
clone = Spec.__new__(Spec)
clone._dup(self, deps=deps, **kwargs)
return clone
@property
def version(self):
if not self.versions.concrete:
raise spack.error.SpecError("Spec version is not concrete: " + str(self))
return self.versions[0]
def __getitem__(self, name: str):
"""Get a dependency from the spec by its name. This call implicitly
sets a query state in the package being retrieved. The behavior of
packages may be influenced by additional query parameters that are
passed after a colon symbol.
Note that if a virtual package is queried a copy of the Spec is
returned while for non-virtual a reference is returned.
"""
query_parameters: List[str] = name.split(":")
if len(query_parameters) > 2:
raise KeyError("key has more than one ':' symbol. At most one is admitted.")
name, query_parameters = query_parameters[0], query_parameters[1:]
if query_parameters:
# We have extra query parameters, which are comma separated
# values
csv = query_parameters.pop().strip()
query_parameters = re.split(r"\s*,\s*", csv)
# Consider all direct dependencies and transitive runtime dependencies
order = itertools.chain(
self.edges_to_dependencies(depflag=dt.BUILD | dt.TEST),
self.traverse_edges(deptype=dt.LINK | dt.RUN, order="breadth", cover="edges"),
)
try:
edge = next((e for e in order if e.spec.name == name or name in e.virtuals))
except StopIteration as e:
raise KeyError(f"No spec with name {name} in {self}") from e
if self._concrete:
return SpecBuildInterface(
edge.spec, name, query_parameters, _parent=self, is_virtual=name in edge.virtuals
)
return edge.spec
def __contains__(self, spec):
"""True if this spec or some dependency satisfies the spec.
Note: If ``spec`` is anonymous, we ONLY check whether the root
satisfies it, NOT dependencies. This is because most anonymous
specs (e.g., ``@1.2``) don't make sense when applied across an
entire DAG -- we limit them to the root.
"""
spec = self._autospec(spec)
# if anonymous or same name, we only have to look at the root
if not spec.name or spec.name == self.name:
return self.satisfies(spec)
try:
dep = self[spec.name]
except KeyError:
return False
return dep.satisfies(spec)
[docs]
def eq_dag(self, other, deptypes=True, vs=None, vo=None):
"""True if the full dependency DAGs of specs are equal."""
if vs is None:
vs = set()
if vo is None:
vo = set()
vs.add(id(self))
vo.add(id(other))
if not self.eq_node(other):
return False
if len(self._dependencies) != len(other._dependencies):
return False
ssorted = [self._dependencies[name] for name in sorted(self._dependencies)]
osorted = [other._dependencies[name] for name in sorted(other._dependencies)]
for s_dspec, o_dspec in zip(
itertools.chain.from_iterable(ssorted), itertools.chain.from_iterable(osorted)
):
if deptypes and s_dspec.depflag != o_dspec.depflag:
return False
s, o = s_dspec.spec, o_dspec.spec
visited_s = id(s) in vs
visited_o = id(o) in vo
# Check for duplicate or non-equal dependencies
if visited_s != visited_o:
return False
# Skip visited nodes
if visited_s or visited_o:
continue
# Recursive check for equality
if not s.eq_dag(o, deptypes, vs, vo):
return False
return True
def _cmp_node(self):
"""Yield comparable elements of just *this node* and not its deps."""
yield self.name
yield self.namespace
yield self.versions
yield self.variants
yield self.compiler_flags
yield self.architecture
yield self.abstract_hash
# this is not present on older specs
yield getattr(self, "_package_hash", None)
[docs]
def eq_node(self, other):
"""Equality with another spec, not including dependencies."""
return (other is not None) and lang.lazy_eq(self._cmp_node, other._cmp_node)
def _cmp_fast_eq(self, other) -> Optional[bool]:
"""Short-circuit compare with other for equality, for lazy_lexicographic_ordering."""
# If there is ever a breaking change to hash computation, whether accidental or purposeful,
# two specs can be identical modulo DAG hash, depending on what time they were concretized
# From the perspective of many operation in Spack (database, build cache, etc) a different
# DAG hash means a different spec. Here we ensure that two otherwise identical specs, one
# serialized before the hash change and one after, are considered different.
if self is other:
return True
if self.concrete and other and other.concrete:
return self.dag_hash() == other.dag_hash()
return None
def _cmp_iter(self):
"""Lazily yield components of self for comparison."""
# Spec comparison in Spack needs to be fast, so there are several cases here for
# performance. The main places we care about this are:
#
# * Abstract specs: there are lots of abstract specs in package.py files,
# which are put into metadata dictionaries and sorted during concretization
# setup. We want comparing abstract specs to be fast.
#
# * Concrete specs: concrete specs are bigger and have lots of nodes and
# edges. Because of the graph complexity, we need a full, linear time
# traversal to compare them -- that's pretty much is unavoidable. But they
# also have precoputed cryptographic hashes (dag_hash()), which we can use
# to do fast equality comparison. See _cmp_fast_eq() above for the
# short-circuit logic for hashes.
#
# A full traversal involves constructing data structures, visitor objects, etc.,
# and it can be expensive if we have to do it to compare a bunch of tiny
# abstract specs. Therefore, there are 3 cases below, which avoid calling
# `spack.traverse.traverse_edges()` unless necessary.
#
# WARNING: the cases below need to be consistent, so don't mess with this code
# unless you really know what you're doing. Be sure to keep all three consistent.
#
# All cases lazily yield:
#
# 1. A generator over nodes
# 2. A generator over canonical edges
#
# Canonical edges have consistent ids defined by breadth-first traversal order. That is,
# the root is always 0, dependencies of the root are 1, 2, 3, etc., and so on.
#
# The three cases are:
#
# 1. Spec has no dependencies
# * We can avoid any traversal logic and just yield this node's _cmp_node generator.
#
# 2. Spec has dependencies, but dependencies have no dependencies.
# * We need to sort edges, but we don't need to track visited nodes, which
# can save us the cost of setting up all the tracking data structures
# `spack.traverse` uses.
#
# 3. Spec has dependencies that have dependencies.
# * In this case, the spec is *probably* concrete. Equality comparisons
# will be short-circuited by dag_hash(), but other comparisons will need
# to lazily enumerate components of the spec. The traversal logic is
# unavoidable.
#
# TODO: consider reworking `spack.traverse` to construct fewer data structures
# and objects, as this would make all traversals faster and could eliminate the
# need for the complexity here. It was not clear at the time of writing that how
# much optimization was possible in `spack.traverse`.
sorted_l1_edges = None
edge_list = None
node_ids = None
def nodes():
nonlocal sorted_l1_edges
nonlocal edge_list
nonlocal node_ids
# Level 0: root node
yield self._cmp_node # always yield the root (this node)
if not self._dependencies: # done if there are no dependencies
return
# Level 1: direct dependencies
# we can yield these in sorted order without tracking visited nodes
deps_have_deps = False
sorted_l1_edges = spack.traverse.sort_edges(self.edges_to_dependencies(depflag=dt.ALL))
for edge in sorted_l1_edges:
yield edge.spec._cmp_node
if edge.spec._dependencies:
deps_have_deps = True
if not deps_have_deps: # done if level 1 specs have no dependencies
return
# Level 2: dependencies of direct dependencies
# now it's general; we need full traverse() to track visited nodes
l1_specs = [edge.spec for edge in sorted_l1_edges]
# the node_ids dict generates consistent ids based on BFS traversal order
# these are used to identify edges later
node_ids = collections.defaultdict(lambda: len(node_ids))
node_ids[id(self)] # self is 0
for spec in l1_specs:
node_ids[id(spec)] # l1 starts at 1
edge_list = []
for edge in spack.traverse.traverse_edges(
l1_specs, order="breadth", cover="edges", root=False
):
# yield each node only once, and generate a consistent id for it the
# first time it's encountered.
if id(edge.spec) not in node_ids:
yield edge.spec._cmp_node
node_ids[id(edge.spec)]
if edge.parent is None: # skip fake edge to root
continue
edge_list.append(
(
node_ids[id(edge.parent)],
node_ids[id(edge.spec)],
edge.depflag,
edge.virtuals,
edge.direct,
edge.propagation,
edge.when,
)
)
def edges():
# no edges in single-node graph
if not self._dependencies:
return
# level 1 edges all start with zero
for i, edge in enumerate(sorted_l1_edges, start=1):
yield (0, i, edge.depflag, edge.virtuals, edge.direct, edge.propagation, edge.when)
# yield remaining edges in the order they were encountered during traversal
if edge_list:
yield from edge_list
yield nodes
yield edges
@property
def namespace_if_anonymous(self):
return self.namespace if not self.name else None
@property
def fullname_if_abstract(self):
"""The namespace-qualified name of a named abstract spec. A concrete spec always has
a namespace, so its default format prints the plain name. An anonymous spec renders
its namespace as a separate ``namespace=`` token."""
return self.fullname if self.name and not self.concrete else self.name
def _format_default(self) -> str:
"""Fast path for formatting with DEFAULT_FORMAT and no color.
This method manually concatenates the string representation of spec attributes,
avoiding the regex parsing overhead of the general format() method.
"""
parts = []
if self.name:
if self.namespace and not self.concrete:
parts.append(f"{self.namespace}.{self.name}")
else:
parts.append(self.name)
if self.versions:
version_str = str(self.versions)
if version_str and version_str != ":": # only include if not full range
parts.append(f"@{version_str}")
compiler_flags_str = str(self.compiler_flags)
if compiler_flags_str:
parts.append(compiler_flags_str)
variants_str = self.variants.string(abbreviate_patches=self._concrete)
if variants_str:
parts.append(variants_str)
if not self.name and self.namespace:
parts.append(f" namespace={self.namespace}")
if self.architecture:
if self.architecture.platform:
parts.append(f" platform={self.architecture.platform}")
if self.architecture.os:
parts.append(f" os={self.architecture.os}")
if self.architecture.target:
parts.append(f" target={self.architecture.target}")
# The blank is required for round-tripping: ``key=value /abc`` parses as variant and
# abstract hash, whereas ``key=value/abc`` is parsed as a variant with value ``value/abc``.
if self.abstract_hash:
parts.append(f" /{self.abstract_hash}")
return "".join(parts).strip()
def _format_edge_attributes(self, dep: DependencySpec, deptypes=True, virtuals=True):
deptypes_str = (
f"deptypes={','.join(dt.flag_to_tuple(dep.depflag))}"
if deptypes and dep.depflag
else ""
)
when_str = f"when='{(dep.when)}'" if dep.when != EMPTY_SPEC else ""
virtuals_str = f"virtuals={','.join(dep.virtuals)}" if virtuals and dep.virtuals else ""
attrs = " ".join(s for s in (when_str, deptypes_str, virtuals_str) if s)
if attrs:
attrs = f"[{attrs}] "
return attrs
def _format_dependencies(
self,
format_string: str = DEFAULT_FORMAT,
include: Optional[Callable[[DependencySpec], bool]] = None,
deptypes: bool = True,
color: Optional[bool] = False,
_force_direct: bool = False,
):
"""Helper for formatting dependencies on specs.
Arguments:
format_string: format string to use for each dependency
include: predicate to select which dependencies to include
deptypes: whether to format deptypes
color: colorize if True, don't colorize if False, auto-colorize if None
_force_direct: if True, print all dependencies as direct dependencies
(to be removed when we have this metadata on concrete edges)
"""
include = include or (lambda dep: True)
parts = []
if self.concrete:
direct = self.edges_to_dependencies()
transitive: List[DependencySpec] = []
else:
direct, transitive = lang.stable_partition(
self.edges_to_dependencies(), predicate_fn=lambda x: x.direct
)
# helper for direct and transitive loops below
def format_edge(edge: DependencySpec, sigil: str, dep_spec: Optional[Spec] = None) -> str:
dep_spec = dep_spec or edge.spec
dep_format = dep_spec.format(format_string, color=color)
edge_attributes = (
self._format_edge_attributes(edge, deptypes=deptypes, virtuals=False)
if edge.depflag or edge.when != EMPTY_SPEC
else ""
)
virtuals = f"{','.join(edge.virtuals)}=" if edge.virtuals else ""
star = _anonymous_star(edge, dep_format)
return f"{sigil}{edge_attributes}{star}{virtuals}{dep_format}"
# direct dependencies
for edge in sorted(direct, key=lambda x: x.spec.name):
if not include(edge):
continue
# replace legacy compiler names
old_name = edge.spec.name
new_name = spack.aliases.BUILTIN_TO_LEGACY_COMPILER.get(old_name)
try:
# this is ugly but copies can be expensive
sigil = "%"
if new_name:
edge.spec.name = new_name
if edge.propagation == PropagationPolicy.PREFERENCE:
sigil = "%%"
parts.append(format_edge(edge, sigil=sigil, dep_spec=edge.spec))
finally:
edge.spec.name = old_name
if self.concrete:
# Concrete specs should go no further, as the complexity
# below is O(paths)
return " ".join(parts).strip()
# transitive dependencies (with any direct dependencies)
for edge in sorted(transitive, key=lambda x: x.spec.name):
if not include(edge):
continue
sigil = "%" if _force_direct else "^" # hack til direct deps represented better
parts.append(format_edge(edge, sigil, edge.spec))
# also recursively add any direct dependencies of transitive dependencies
if edge.spec._dependencies:
parts.append(
edge.spec._format_dependencies(
format_string=format_string,
include=include,
deptypes=deptypes,
color=color,
_force_direct=_force_direct,
)
)
return " ".join(parts).strip()
def _long_spec(self, color: Optional[bool] = False) -> str:
"""Helper for :attr:`long_spec` and :attr:`clong_spec`."""
if self.concrete:
return self.tree(format=DISPLAY_FORMAT, color=color)
return f"{self.format(color=color)} {self._format_dependencies(color=color)}".strip()
def _short_spec(self, color: Optional[bool] = False) -> str:
"""Helper for :attr:`short_spec` and :attr:`cshort_spec`."""
return self.format(
"{name}{@version}{variants}"
"{ platform=architecture.platform}{ os=architecture.os}{ target=architecture.target}"
"{/hash:7}",
color=color,
)
@property
def compilers(self):
if self.original_spec_format() < 5:
# These specs don't have compilers as dependencies, return the compiler node attribute
return f" %{self.compiler}"
# TODO: get rid of the space here and make formatting smarter
return " " + self._format_dependencies(
"{name}{@version}",
include=lambda dep: any(lang in dep.virtuals for lang in ("c", "cxx", "fortran")),
deptypes=False,
_force_direct=True,
)
@property
def long_spec(self):
"""Long string of the spec, including dependencies."""
return self._long_spec(color=False)
@property
def clong_spec(self):
"""Returns an auto-colorized version of :attr:`long_spec`."""
return self._long_spec(color=None)
@property
def short_spec(self):
"""Short string of the spec, with hash and without dependencies."""
return self._short_spec(color=False)
@property
def cshort_spec(self):
"""Returns an auto-colorized version of :attr:`short_spec`."""
return self._short_spec(color=None)
@property
def colored_str(self) -> str:
"""Auto-colorized string representation of this spec."""
return self._str(color=None)
def _str(self, color: Optional[bool] = False) -> str:
"""String representation of this spec.
Args:
color: colorize if True, don't colorize if False, auto-colorize if None
"""
if self._concrete:
return self.format("{name}{@version}{/hash}", color=color)
if not self._dependencies:
return self.format(color=color)
return self._long_spec(color=color)
def __str__(self) -> str:
"""String representation of this spec."""
return self._str(color=False)
[docs]
def tree(
self,
*,
color: Optional[bool] = None,
depth: bool = False,
hashes: bool = False,
hashlen: Optional[int] = None,
cover: spack.traverse.CoverType = "nodes",
indent: int = 0,
format: str = DEFAULT_FORMAT,
deptypes: Union[dt.DepTypes, dt.DepFlag] = dt.ALL,
show_types: bool = False,
depth_first: bool = False,
recurse_dependencies: bool = True,
status_fn: Optional[Callable[["Spec"], InstallStatus]] = None,
prefix: Optional[Callable[["Spec"], str]] = None,
key=id,
version_style_fn: Optional[Callable[["Spec"], spack.enums.PartStyle]] = None,
variant_style_fn: Optional[Callable[["Spec", str], spack.enums.PartStyle]] = None,
architecture_style_fn: Optional[Callable[["Spec", str], spack.enums.PartStyle]] = None,
) -> str:
"""Prints out this spec and its dependencies, tree-formatted with indentation.
See multi-spec ``spack.spec.tree()`` function for details.
Args:
specs: List of specs to format.
color: if True, always colorize the tree. If False, don't colorize the tree. If None,
use the default from spack.util.tty.color
depth: print the depth from the root
hashes: if True, print the hash of each node
hashlen: length of the hash to be printed
cover: either ``"nodes"`` or ``"edges"``
indent: extra indentation for the tree being printed
format: format to be used to print each node
deptypes: dependency types to be represented in the tree
show_types: if True, show the (merged) dependency type of a node
depth_first: if True, traverse the DAG depth first when representing it as a tree
recurse_dependencies: if True, recurse on dependencies
status_fn: optional callable that takes a node as an argument and return its
installation status
prefix: optional callable that takes a node as an argument and return its
installation prefix
version_style_fn: optional callable ``(node) -> PartStyle`` controlling version
rendering
variant_style_fn: optional callable ``(node, key) -> PartStyle`` controlling variant
rendering
architecture_style_fn: optional callable ``(node, part) -> PartStyle`` controlling
architecture part rendering
"""
return tree(
[self],
color=color,
depth=depth,
hashes=hashes,
hashlen=hashlen,
cover=cover,
indent=indent,
format=format,
deptypes=deptypes,
show_types=show_types,
depth_first=depth_first,
recurse_dependencies=recurse_dependencies,
status_fn=status_fn,
prefix=prefix,
key=key,
version_style_fn=version_style_fn,
variant_style_fn=variant_style_fn,
architecture_style_fn=architecture_style_fn,
)
def __repr__(self):
return str(self)
@property
def platform(self):
return self.architecture.platform
@property
def os(self):
return self.architecture.os
@property
def target(self):
return self.architecture.target
@property
def build_spec(self):
return self._build_spec or self
@build_spec.setter
def build_spec(self, value):
self._build_spec = value
[docs]
def trim(self, dep_name):
"""
Remove any package that is or provides ``dep_name`` transitively
from this tree. This can also remove other dependencies if
they are only present because of ``dep_name``.
"""
for spec in list(self.traverse()):
new_dependencies = {}
for pkg_name, edge_list in spec._dependencies.items():
for edge in edge_list:
if (dep_name not in edge.virtuals) and (not dep_name == edge.spec.name):
_add_edge_to_map(new_dependencies, edge.spec.name, edge)
spec._dependencies = new_dependencies
def _virtuals_provided(self, root):
"""Return set of virtuals provided by self in the context of root"""
if root is self:
# Could be using any virtual the package can provide
return {v.name for v in self.package.virtuals_provided}
hashes = [s.dag_hash() for s in root.traverse()]
in_edges = set(
[edge for edge in self.edges_from_dependents() if edge.parent.dag_hash() in hashes]
)
return set().union(*[edge.virtuals for edge in in_edges])
def _splice_match(self, other, self_root, other_root):
"""Return True if other is a match for self in a splice of other_root into self_root
Other is a splice match for self if it shares a name, or if self is a virtual provider
and other provides a superset of the virtuals provided by self. Virtuals provided are
evaluated in the context of a root spec (self_root for self, other_root for other).
This is a slight oversimplification. Other could be a match for self in the context of
one edge in self_root and not in the context of another edge. This method could be
expanded in the future to account for these cases.
"""
if other.name == self.name:
return True
return bool(
bool(self._virtuals_provided(self_root))
and self._virtuals_provided(self_root) <= other._virtuals_provided(other_root)
)
def _splice_detach_and_add_dependents(self, replacement, context):
"""Helper method for Spec._splice_helper.
replacement is a node to splice in, context is the scope of dependents to consider relevant
to this splice."""
# Update build_spec attributes for all transitive dependents
# before we start changing their dependencies
ancestors_in_context = [
a
for a in self.traverse(root=False, direction="parents")
if a in context.traverse(deptype=dt.LINK | dt.RUN)
]
for ancestor in ancestors_in_context:
# Only set it if it hasn't been spliced before
ancestor._build_spec = ancestor._build_spec or ancestor.copy()
ancestor.clear_caches(ignore=(ht.package_hash.attr,))
for edge in ancestor.edges_to_dependencies(depflag=dt.BUILD):
if edge.depflag & ~dt.BUILD:
edge.depflag &= ~dt.BUILD
else:
ancestor._dependencies[edge.spec.name].remove(edge)
edge.spec._dependents[ancestor.name].remove(edge)
# For each direct dependent in the link/run graph, replace the dependency on
# node with one on replacement
for edge in self.edges_from_dependents():
if edge.parent not in ancestors_in_context:
continue
edge.parent._dependencies[self.name].remove(edge)
self._dependents[edge.parent.name].remove(edge)
edge.parent._add_dependency(replacement, depflag=edge.depflag, virtuals=edge.virtuals)
def _splice_helper(self, replacement):
"""Main loop of a transitive splice.
The while loop around a traversal of self ensures that changes to self from previous
iterations are reflected in the traversal. This avoids evaluating irrelevant nodes
using topological traversal (all incoming edges traversed before any outgoing edge).
If any node will not be in the end result, its parent will be spliced and it will not
ever be considered.
For each node in self, find any analogous node in replacement and swap it in.
We assume all build deps are handled outside of this method
Arguments:
replacement: The node that will replace any equivalent node in self
self_root: The root of the spec that self comes from. This provides the context for
evaluating whether ``replacement`` is a match for each node of ``self``. See
``Spec._splice_match`` and ``Spec._virtuals_provided`` for details.
other_root: The root of the spec that replacement comes from. This provides the context
for evaluating whether ``replacement`` is a match for each node of ``self``. See
``Spec._splice_match`` and ``Spec._virtuals_provided`` for details.
"""
ids = {id(s) for s in replacement.traverse()}
# Sort all possible replacements by name and virtual for easy access later
replacements_by_name = collections.defaultdict(list)
for node in replacement.traverse():
replacements_by_name[node.name].append(node)
virtuals = node._virtuals_provided(root=replacement)
for virtual in virtuals:
replacements_by_name[virtual].append(node)
changed = True
while changed:
changed = False
# Intentionally allowing traversal to change on each iteration
# using breadth-first traversal to ensure we only reach nodes that will
# be in final result
for node in self.traverse(root=False, order="topo", deptype=dt.ALL & ~dt.BUILD):
# If this node has already been swapped in, don't consider it again
if id(node) in ids:
continue
analogs = replacements_by_name[node.name]
if not analogs:
# If we have to check for matching virtuals, then we need to check that it
# matches all virtuals. Use `_splice_match` to validate possible matches
for virtual in node._virtuals_provided(root=self):
analogs += [
r
for r in replacements_by_name[virtual]
if node._splice_match(r, self_root=self, other_root=replacement)
]
# No match, keep iterating over self
if not analogs:
continue
# If there are multiple analogs, this package must satisfy the constraint
# that a newer version can always replace a lesser version.
analog = max(analogs, key=lambda s: s.version)
# No splice needed here, keep checking
if analog == node:
continue
node._splice_detach_and_add_dependents(analog, context=self)
changed = True
break
[docs]
def splice(self, other: "Spec", transitive: bool = True) -> "Spec":
"""Returns a new, spliced concrete :class:`Spec` with the ``other`` dependency and,
optionally, its dependencies.
Args:
other: alternate dependency
transitive: include other's dependencies
Returns: a concrete, spliced version of the current :class:`Spec`
When transitive is :data:`True`, use the dependencies from ``other`` to reconcile
conflicting dependencies. When transitive is :data:`False`, use dependencies from self.
For example, suppose we have the following dependency graph:
.. code-block:: text
T
| \\
Z<-H
Spec ``T`` depends on ``H`` and ``Z``, and ``H`` also depends on ``Z``. Now we want to use
a different ``H``, called ``H'``. This function can be used to splice in ``H'`` to
create a new spec, called ``T*``. If ``H'`` was built with ``Z'``, then ``transitive=True``
will ensure ``H'`` and ``T*`` both depend on ``Z'``:
.. code-block:: text
T*
| \\
Z'<-H'
If ``transitive=False``, then ``H'`` and ``T*`` will both depend on
the original ``Z``, resulting in a new ``H'*``:
.. code-block:: text
T*
| \\
Z<-H'*
Provenance of the build is tracked through the :attr:`build_spec` property
of the spliced spec and any correspondingly modified dependency specs.
The build specs are set to that of the original spec, so the original
spec's provenance is preserved unchanged."""
assert self.concrete
assert other.concrete
if self._splice_match(other, self_root=self, other_root=other):
return other.copy()
if not any(
node._splice_match(other, self_root=self, other_root=other)
for node in self.traverse(root=False, deptype=dt.LINK | dt.RUN)
):
other_str = other.format("{name}/{hash:7}")
self_str = self.format("{name}/{hash:7}")
msg = f"Cannot splice {other_str} into {self_str}."
msg += f" Either {self_str} cannot depend on {other_str},"
msg += f" or {other_str} fails to provide a virtual used in {self_str}"
raise SpliceError(msg)
# Copies of all non-build deps, build deps will get added at the end
spec = self.copy(deps=dt.ALL & ~dt.BUILD)
replacement = other.copy(deps=dt.ALL & ~dt.BUILD)
def make_node_pairs(orig_spec, copied_spec):
return list(
zip(
orig_spec.traverse(deptype=dt.ALL & ~dt.BUILD),
copied_spec.traverse(deptype=dt.ALL & ~dt.BUILD),
)
)
def mask_build_deps(in_spec):
for edge in in_spec.traverse_edges(cover="edges"):
edge.depflag &= ~dt.BUILD
if transitive:
# These pairs will allow us to reattach all direct build deps
# We need the list of pairs while the two specs still match
node_pairs = make_node_pairs(self, spec)
# Ignore build deps in the modified spec while doing the splice
# They will be added back in at the end
mask_build_deps(spec)
# Transitively splice any relevant nodes from new into base
# This handles all shared dependencies between self and other
spec._splice_helper(replacement)
else:
# Do the same thing as the transitive splice, but reversed
node_pairs = make_node_pairs(other, replacement)
mask_build_deps(replacement)
replacement._splice_helper(spec)
# Intransitively splice replacement into spec
# This is very simple now that all shared dependencies have been handled
for node in spec.traverse(order="topo", deptype=dt.LINK | dt.RUN):
if node._splice_match(other, self_root=spec, other_root=other):
node._splice_detach_and_add_dependents(replacement, context=spec)
# For nodes that were spliced, modify the build spec to ensure build deps are preserved
# For nodes that were not spliced, replace the build deps on the spec itself
for orig, copy in node_pairs:
if copy._build_spec:
copy._build_spec = orig.build_spec.copy()
else:
for edge in orig.edges_to_dependencies(depflag=dt.BUILD):
copy._add_dependency(edge.spec, depflag=dt.BUILD, virtuals=edge.virtuals)
return spec
[docs]
def mutate(self, mutator, rehash=True) -> bool:
"""Mutate concrete spec to match constraints represented by mutator.
Mutation can modify the spec version, variants, compiler flags, and architecture.
Mutation cannot change the spec name, namespace, dependencies, or abstract_hash.
Any attribute which is unset will not be touched.
Variant values can be replaced with the literal ``None`` to remove the variant.
``None`` as a variant value is represented by ``VariantValue(..., (None,))``.
If ``rehash``, concrete spec and its dependents have hashes updated.
Returns whether the spec was modified by the mutation"""
assert self.concrete
if mutator.name and mutator.name != self.name:
raise SpecMutationError(f"Cannot mutate spec name: spec {self} mutator {mutator}")
if len(mutator.dependencies()) > 0:
raise SpecMutationError(f"Cannot mutate dependencies: spec {self} mutator {mutator}")
if (
mutator.versions != vn.VersionList(":")
and not mutator.versions.concrete_range_as_version
):
raise SpecMutationError(
f"Cannot mutate abstract version: spec {self} mutator {mutator}"
)
if mutator.abstract_hash and mutator.abstract_hash != self.abstract_hash:
raise SpecMutationError(f"Cannot mutate abstract_hash: spec {self} mutator {mutator}")
changed = False
if mutator.namespace and mutator.namespace != self.namespace:
self.namespace = mutator.namespace
changed = True
if mutator.versions != vn.VersionList(":") and self.versions != mutator.versions:
self.versions = mutator.versions
changed = True
for name, variant in mutator.variants.items():
if variant == self.variants.get(name, None):
continue
old_variant = self.variants.pop(name, None)
if not isinstance(variant, vt.VariantValueRemoval): # sigil type for removing variant
if old_variant:
variant.type = old_variant.type # coerce variant type to match
self.variants[name] = variant
changed = True
for name, flags in mutator.compiler_flags.items():
if not flags or flags == self.compiler_flags[name]:
continue
self.compiler_flags[name] = flags
changed = True
if mutator.architecture:
if mutator.platform and mutator.platform != self.architecture.platform:
self.architecture.platform = mutator.platform
changed = True
if mutator.os and mutator.os != self.architecture.os:
self.architecture.os = mutator.os
changed = True
if mutator.target and mutator.target != self.architecture.target:
self.architecture.target = mutator.target
changed = True
if changed and rehash:
roots = []
for parent in spack.traverse.traverse_nodes([self], direction="parents"):
if not parent.dependents():
roots.append(parent)
# invalidate hashes
parent._mark_root_concrete(False)
parent.clear_caches()
for root in roots:
# compute new hashes on full DAGs
root._finalize_concretization()
return changed
[docs]
def clear_caches(self, ignore: Tuple[str, ...] = ()) -> None:
"""
Clears all cached hashes in a Spec, while preserving other properties.
"""
for h in ht.HASHES:
if h.attr not in ignore:
if hasattr(self, h.attr):
setattr(self, h.attr, None)
for attr in ("_dunder_hash", "_prefix"):
if attr not in ignore:
setattr(self, attr, None)
def __hash__(self):
# If the spec is concrete, we leverage the dag hash and just use a 64-bit prefix of it.
# The dag hash has the advantage that it's computed once per concrete spec, and it's saved
# -- so if we read concrete specs we don't need to recompute the whole hash.
if self.concrete:
if not self._dunder_hash:
self._dunder_hash = self.dag_hash_bit_prefix(64)
return self._dunder_hash
if not self._dependencies:
return hash(
(
self.name,
self.namespace,
self.versions,
(self.variants if self.variants.dict else None),
self.architecture,
self.abstract_hash,
)
)
return hash(lang.tuplify(self._cmp_iter))
def __getstate__(self):
state = self.__dict__.copy()
# The package is lazily loaded upon demand.
state.pop("_package", None)
# As with to_dict, do not include dependents. This avoids serializing more than intended.
state.pop("_dependents", None)
# Do not pickle attributes dynamically set by SpecBuildInterface
state.pop("wrapped_obj", None)
state.pop("token", None)
state.pop("last_query", None)
state.pop("indirect_spec", None)
# Optimize variants and compiler_flags serialization
variants = state.pop("variants", None)
if variants:
state["_variants_data"] = variants.dict
flags = state.pop("compiler_flags", None)
if flags:
state["_compiler_flags_data"] = flags.dict
return state
def __setstate__(self, state):
variants_data = state.pop("_variants_data", None)
compiler_flags_data = state.pop("_compiler_flags_data", None)
self.__dict__.update(state)
self._package = None
# Reconstruct variants and compiler_flags
self.variants = VariantMap()
self.compiler_flags = FlagMap()
if variants_data is not None:
self.variants.dict = variants_data
if compiler_flags_data is not None:
self.compiler_flags.dict = compiler_flags_data
# Reconstruct dependents map
if not hasattr(self, "_dependents"):
self._dependents = {}
for edges in self._dependencies.values():
for edge in edges:
if not hasattr(edge.spec, "_dependents"):
edge.spec._dependents = {}
_add_edge_to_map(edge.spec._dependents, edge.parent.name, edge)
[docs]
def attach_git_version_lookup(self):
# Add a git lookup method for GitVersions
if not self.name:
return
for v in self.versions:
if isinstance(v, vn.GitVersion) and v.std_version is None:
v.attach_lookup(spack.version.git_ref_lookup.GitRefLookup(self.fullname))
[docs]
def has_virtual_dependency(self, virtual: str) -> bool:
return bool(self.dependencies(virtuals=(virtual,)))
[docs]
class VariantMap(lang.HashableMap[str, vt.VariantValue]):
"""Map containing variant instances. New values can be added only
if the key is not already present."""
__slots__ = ()
def __setitem__(self, name, vspec):
# Raise a TypeError if vspec is not of the right type
if not isinstance(vspec, vt.VariantValue):
raise TypeError(
"VariantMap accepts only values of variant types "
f"[got {type(vspec).__name__} instead]"
)
# Raise an error if the variant was already in this map
if name in self.dict:
msg = 'Cannot specify variant "{0}" twice'.format(name)
raise vt.DuplicateVariantError(msg)
# Raise an error if name and vspec.name don't match
if name != vspec.name:
raise KeyError(
f'Inconsistent key "{name}", must be "{vspec.name}" to match VariantSpec'
)
# Set the item
super().__setitem__(name, vspec)
[docs]
def substitute(self, vspec):
"""Substitutes the entry under ``vspec.name`` with ``vspec``.
Args:
vspec: variant spec to be substituted
"""
if vspec.name not in self:
raise KeyError(f"cannot substitute a key that does not exist [{vspec.name}]")
# Set the item
super().__setitem__(vspec.name, vspec)
[docs]
def partition_variants(self):
non_prop, prop = lang.stable_partition(self.values(), lambda x: not x.propagate)
# Just return the names
non_prop = [x.name for x in non_prop]
prop = [x.name for x in prop]
return non_prop, prop
[docs]
def copy(self) -> "VariantMap":
clone = VariantMap()
for name, variant in self.items():
clone[name] = variant.copy()
return clone
[docs]
def string(self, abbreviate_patches: bool = False) -> str:
"""The string representation of the map. ``abbreviate_patches`` is passed on to each
variant, see :meth:`~spack.variant.VariantValue.string`."""
if not self:
return ""
# Separate boolean variants from key-value pairs as they print
# differently. All booleans go first to avoid ' ~foo' strings that
# break spec reuse in zsh.
bool_keys, kv_keys = self.partition_keys()
# add spaces before and after key/value variants.
string = io.StringIO()
for key in bool_keys:
string.write(self[key].string(abbreviate_patches))
for key in kv_keys:
string.write(" ")
string.write(self[key].string(abbreviate_patches))
return string.getvalue()
def __str__(self):
return self.string()
[docs]
def partition_keys(self) -> Tuple[List[str], List[str]]:
"""Partition the keys of the map into two lists: booleans and key-value pairs."""
bool_keys, kv_keys = lang.stable_partition(
sorted(self.keys()), lambda x: self[x].type == vt.VariantType.BOOL
)
return bool_keys, kv_keys
[docs]
class SpecBuildInterface(lang.ObjectWrapper, Spec):
# home is available in the base Package so no default is needed
home = ForwardQueryToPackage("home", default_handler=None)
headers = ForwardQueryToPackage("headers", default_handler=_headers_default_handler)
libs = ForwardQueryToPackage("libs", default_handler=_libs_default_handler)
command = ForwardQueryToPackage("command", default_handler=None, _indirect=True)
def __init__(
self,
spec: "Spec",
name: str,
query_parameters: List[str],
_parent: "Spec",
is_virtual: bool,
):
lang.ObjectWrapper.__init__(self, spec)
# Adding new attributes goes after ObjectWrapper.__init__ call since the ObjectWrapper
# resets __dict__ to behave like the passed object
original_spec = getattr(spec, "wrapped_obj", spec)
self.wrapped_obj = original_spec
self.token = original_spec, name, query_parameters, _parent, is_virtual
self.last_query = QueryState(
name=name, extra_parameters=query_parameters, isvirtual=is_virtual
)
# TODO: this ad-hoc logic makes `spec["python"].command` return
# `spec["python-venv"].command` and should be removed when `python` is a virtual.
self.indirect_spec = None
if spec.name == "python":
python_venvs = _parent.dependencies("python-venv")
if not python_venvs:
return
self.indirect_spec = python_venvs[0]
def __reduce__(self):
return SpecBuildInterface, self.token
[docs]
def copy(self, *args, **kwargs):
return self.wrapped_obj.copy(*args, **kwargs)
[docs]
def substitute_abstract_variants(spec: Spec):
"""Uses the information in ``spec.package`` to turn any variant that needs
it into a SingleValuedVariant or BoolValuedVariant.
This method is best effort. All variants that can be substituted will be
substituted before any error is raised.
Args:
spec: spec on which to operate the substitution
"""
# This method needs to be best effort so that it works in matrix exclusion
# in $spack/lib/spack/spack/spec_list.py
unknown = []
for name, v in spec.variants.items():
if v.concrete and v.type == vt.VariantType.MULTI:
continue
if name in ("dev_path", "commit"):
v.type = vt.VariantType.SINGLE
v.concrete = True
continue
elif name in vt.RESERVED_NAMES:
continue
variant_defs = spack.repo.PATH.get_pkg_class(spec.fullname).variant_definitions(name)
valid_defs = []
for when, vdef in variant_defs:
if when.intersects(spec):
valid_defs.append(vdef)
if not valid_defs:
if name not in spack.repo.PATH.get_pkg_class(spec.fullname).variant_names():
unknown.append(name)
else:
whens = [str(when) for when, _ in variant_defs]
raise InvalidVariantForSpecError(v.name, f"({', '.join(whens)})", spec)
continue
pkg_variant, *rest = valid_defs
if rest:
continue
new_variant = pkg_variant.make_variant(*v.values)
pkg_variant.validate_or_raise(new_variant, spec.name)
spec.variants.substitute(new_variant)
if unknown:
variants = spack.util.string.plural(len(unknown), "variant")
raise vt.UnknownVariantError(
f"Tried to set {variants} {spack.util.string.comma_and(unknown)}. "
f"{spec.name} has no such {variants}",
unknown_variants=unknown,
)
[docs]
def parse_with_version_concrete(spec_like: Union[str, Spec]):
"""Same as Spec(string), but interprets @x as @=x"""
s = Spec(spec_like)
interpreted_version = s.versions.concrete_range_as_version
if interpreted_version:
s.versions = vn.VersionList([interpreted_version])
return s
[docs]
def reconstruct_virtuals_on_edges(spec: Spec) -> None:
"""Reconstruct virtuals on edges. Used to read from old DB and reindex."""
virtuals_needed: Dict[str, Set[str]] = {}
virtuals_provided: Dict[str, Set[str]] = {}
for edge in spec.traverse_edges(cover="edges", root=False):
parent_key = edge.parent.dag_hash()
if parent_key not in virtuals_needed:
# Construct which virtuals are needed by parent
virtuals_needed[parent_key] = set()
try:
parent_pkg = edge.parent.package
except Exception as e:
warnings.warn(
f"cannot reconstruct virtual dependencies on {edge.parent.name}: {e}"
)
continue
virtuals_needed[parent_key].update(
name
for name, when_deps in parent_pkg.dependencies_by_name(when=True).items()
if spack.repo.PATH.is_virtual(name)
and any(edge.parent.satisfies(x) for x in when_deps)
)
if not virtuals_needed[parent_key]:
continue
child_key = edge.spec.dag_hash()
if child_key not in virtuals_provided:
virtuals_provided[child_key] = set()
try:
child_pkg = edge.spec.package
except Exception as e:
warnings.warn(
f"cannot reconstruct virtual dependencies on {edge.parent.name}: {e}"
)
continue
virtuals_provided[child_key].update(x.name for x in child_pkg.virtuals_provided)
if not virtuals_provided[child_key]:
continue
virtuals_to_add = virtuals_needed[parent_key] & virtuals_provided[child_key]
if virtuals_to_add:
edge.update_virtuals(virtuals_to_add)
[docs]
class DepSpecComponents(NamedTuple):
"""A dependency edge as it is stored in a spec file. The fields ``direct``, ``when``, and
``propagation`` only occur on edges of abstract specs, and only from specfile v5 on."""
name: str
hash: str
deptypes: List[str]
hash_type: str
virtuals: Tuple[str, ...]
direct: bool
when: str = ""
propagation: str = PropagationPolicy.NONE.name
_SPECFILE_READERS: Dict[int, Type["SpecfileReaderBase"]] = {}
[docs]
def register_reader(cls: Type["SpecfileReaderBase"]) -> Type["SpecfileReaderBase"]:
"""Register a SpecfileReaderBase subclass under its SPEC_VERSION."""
if "SPEC_VERSION" not in cls.__dict__:
raise TypeError(f"{cls.__name__} must define SPEC_VERSION to be registered")
_SPECFILE_READERS[cls.SPEC_VERSION] = cls
return cls
[docs]
class SpecfileReaderBase(abc.ABC):
SPEC_VERSION: ClassVar[int]
[docs]
@classmethod
@abc.abstractmethod
def load(cls, data) -> Spec: ...
[docs]
@classmethod
@abc.abstractmethod
def dependencies_from_node_dict(cls, node) -> List[DepSpecComponents]: ...
[docs]
@classmethod
@abc.abstractmethod
def read_specfile_dep_specs(
cls, deps: Dict, hash_type: str = ht.dag_hash.name
) -> List[DepSpecComponents]: ...
cls, node, hash_type=ht.dag_hash.name
) -> Tuple[str, str, str]: ...
[docs]
@classmethod
def from_node_dict(cls, node):
spec = Spec()
name, node = cls.name_and_data(node)
for h in ht.HASHES:
setattr(spec, h.attr, node.get(h.name, None))
# old anonymous spec files had name=None, we use name="" now
spec.name = name if isinstance(name, str) else ""
spec.namespace = node.get("namespace", None)
spec.abstract_hash = node.get("abstract_hash", None)
if "version" in node or "versions" in node:
spec.versions = vn.VersionList.from_dict(node)
spec.attach_git_version_lookup()
if "arch" in node:
spec.architecture = ArchSpec.from_dict(node)
# "compiler_flags" supersedes the flags under "parameters": it records propagation per
# flag, where "propagate" only records propagation per flag type.
spec.compiler_flags = FlagMap.from_dict(node.get("compiler_flags", {}))
propagated_names = node.get("propagate", [])
abstract_variants = set(node.get("abstract", ()))
for name, values in node.get("parameters", {}).items():
propagate = name in propagated_names
if name in _valid_compiler_flags:
if name in spec.compiler_flags:
continue
spec.compiler_flags[name] = []
for val in values:
spec.compiler_flags.add_flag(name, val, propagate)
else:
spec.variants[name] = vt.VariantValue.from_node_dict(
name, values, propagate=propagate, abstract=name in abstract_variants
)
spec.external_path = None
spec.external_modules = None
if "external" in node:
# This conditional is needed because sometimes this function is
# called with a node already constructed that contains a 'versions'
# and 'external' field. Related to virtual packages provider
# indexes.
if node["external"]:
spec.external_path = node["external"]["path"]
spec.external_modules = node["external"]["module"]
if spec.external_modules is False:
spec.external_modules = None
spec.extra_attributes = node["external"].get("extra_attributes") or {}
# specs read in are concrete unless marked abstract
if node.get("concrete", True):
spec._mark_root_concrete()
if "patches" in node:
patches = node["patches"]
if len(patches) > 0:
mvar = spec.variants.setdefault("patches", vt.MultiValuedVariant("patches", ()))
mvar.set(*patches)
# FIXME: Monkey patches mvar to store patches order
mvar._patches_in_order_of_appearance = patches
# Annotate the compiler spec, might be used later
if "annotations" not in node:
# Specfile v4 and earlier
spec.annotations.with_spec_format(cls.SPEC_VERSION)
if "compiler" in node:
spec.annotations.with_compiler(cls.legacy_compiler(node))
else:
spec.annotations.with_spec_format(node["annotations"]["original_specfile_version"])
if "compiler" in node["annotations"]:
spec.annotations.with_compiler(Spec(f"{node['annotations']['compiler']}"))
# Don't read dependencies here; from_dict() is used by
# from_yaml() and from_json() to read the root *and* each dependency
# spec.
return spec
[docs]
@classmethod
def legacy_compiler(cls, node):
d = node["compiler"]
return Spec(f"{d['name']}@{vn.VersionList.from_dict(d)}")
@classmethod
def _load(cls, data) -> Spec:
"""Construct a spec from JSON/YAML using the format version 2.
This format is used in Spack v0.17, was introduced in
https://github.com/spack/spack/pull/22845
Args:
data: a nested dict/list data structure read from YAML or JSON.
"""
# Current specfile format
nodes = data["spec"]["nodes"]
if not nodes:
raise spack.error.SpecError("Spec dictionary contains no nodes.")
# Pass 0: Determine hash type
hash_type = None
any_deps = False
for node in nodes:
for dep in cls.dependencies_from_node_dict(node):
any_deps = True
if dep.hash_type:
hash_type = dep.hash_type
break
if not any_deps: # If we never see a dependency...
hash_type = ht.dag_hash.name
elif not hash_type: # Seen a dependency, still don't know hash_type
raise spack.error.SpecError(
"Spec dictionary contains malformed dependencies. Old format?"
)
specs_by_hash = wire_spec_nodes(nodes, hash_type, cls)
root_spec_hash = nodes[0][hash_type]
return specs_by_hash[root_spec_hash]
[docs]
def wire_spec_nodes(
nodes: List[Dict], hash_type: str, reader: Type[SpecfileReaderBase]
) -> Dict[str, Spec]:
"""Given a list of spec node dicts, wire them together and return a dict keyed by hash.
This is the part of SpecfileV2 and onwards that wires up specs, based on hashes in
JSON spec data.
Raises:
MissingSpecHashError: if a node references a hash not present in ``nodes``.
"""
# Pass 1: Create a single lookup dictionary by hash
specs_by_hash = {node[hash_type]: reader.from_node_dict(node) for node in nodes}
# Pass 2: Finish construction of all DAG edges (including build specs)
for node in nodes:
node_spec = specs_by_hash[node[hash_type]]
for dep in reader.dependencies_from_node_dict(node):
dep_spec = specs_by_hash.get(dep.hash)
if dep_spec is None:
raise MissingSpecHashError(
f"node '{node['name']}' references missing dep hash {dep.name}/{dep.hash}"
)
# Add edges exactly as they are stored
edge = DependencySpec(
node_spec,
dep_spec,
depflag=dt.canonicalize(dep.deptypes),
virtuals=dep.virtuals,
direct=dep.direct,
when=Spec(dep.when) if dep.when else EMPTY_SPEC,
propagation=PropagationPolicy[dep.propagation],
)
_add_edge_to_map(node_spec._dependencies, edge.spec.name, edge)
_add_edge_to_map(edge.spec._dependents, edge.parent.name, edge)
if "build_spec" in node.keys():
bname, bhash, _ = reader.extract_build_spec_info_from_node_dict(
node, hash_type=hash_type
)
build_spec = specs_by_hash.get(bhash)
if build_spec is None:
raise MissingSpecHashError(
f"node '{node['name']}' references missing build_spec hash {bname}/{bhash}"
)
node_spec._build_spec = build_spec
return specs_by_hash
[docs]
@register_reader
class SpecfileV1(SpecfileReaderBase):
SPEC_VERSION = 1
[docs]
@classmethod
def load(cls, data) -> Spec:
"""Construct a spec from JSON/YAML using the format version 1.
Note: Version 1 format has no notion of a build_spec, and names are
guaranteed to be unique. This function is guaranteed to read specs as
old as v0.10 - while it was not checked for older formats.
Args:
data: a nested dict/list data structure read from YAML or JSON.
"""
nodes = data["spec"]
# Read nodes out of list. Root spec is the first element;
# dependencies are the following elements.
dep_list = [cls.from_node_dict(node) for node in nodes]
if not dep_list:
raise spack.error.SpecError("specfile contains no nodes.")
deps = {spec.name: spec for spec in dep_list}
result = dep_list[0]
for node in nodes:
# get dependency dict from the node.
name, data = cls.name_and_data(node)
for dep in cls.dependencies_from_node_dict(data):
deps[name]._add_dependency(
deps[dep.name],
depflag=dt.canonicalize(dep.deptypes),
virtuals=dep.virtuals,
direct=dep.direct,
)
reconstruct_virtuals_on_edges(result)
return result
[docs]
@classmethod
def name_and_data(cls, node):
name = next(iter(node))
node = node[name]
return name, node
[docs]
@classmethod
def dependencies_from_node_dict(cls, node) -> List[DepSpecComponents]:
if "dependencies" not in node:
return []
return cls.read_specfile_dep_specs(node["dependencies"])
[docs]
@classmethod
def read_specfile_dep_specs(cls, deps, hash_type=ht.dag_hash.name) -> List[DepSpecComponents]:
"""Read the DependencySpec portion of a YAML-formatted Spec.
This needs to be backward-compatible with older spack spec
formats so that reindex will work on old specs/databases.
"""
dspec_list: List[DepSpecComponents] = []
for dep_name, elt in deps.items():
if isinstance(elt, dict):
for h in ht.HASHES:
if h.name in elt:
dep_hash, deptypes = elt[h.name], elt["type"]
hash_type = h.name
break
else: # We never determined a hash type...
raise spack.error.SpecError("Couldn't parse dependency spec.")
else:
raise spack.error.SpecError("Couldn't parse dependency types in spec.")
dspec_list.append(
DepSpecComponents(
name=dep_name,
hash=dep_hash,
deptypes=list(deptypes),
hash_type=hash_type,
virtuals=(),
direct=True,
)
)
return dspec_list
[docs]
@register_reader
class SpecfileV2(SpecfileReaderBase):
SPEC_VERSION = 2
[docs]
@classmethod
def load(cls, data) -> Spec:
result = cls._load(data)
reconstruct_virtuals_on_edges(result)
return result
[docs]
@classmethod
def name_and_data(cls, node):
return node["name"], node
[docs]
@classmethod
def dependencies_from_node_dict(cls, node) -> List[DepSpecComponents]:
return cls.read_specfile_dep_specs(node.get("dependencies", []))
[docs]
@classmethod
def read_specfile_dep_specs(cls, deps, hash_type=ht.dag_hash.name) -> List[DepSpecComponents]:
"""Read the DependencySpec portion of a YAML-formatted Spec.
This needs to be backward-compatible with older spack spec
formats so that reindex will work on old specs/databases.
"""
if not isinstance(deps, list):
raise spack.error.SpecError("Spec dictionary contains malformed dependencies")
result = []
for elt in deps:
if isinstance(elt, dict):
# new format: elements of dependency spec are keyed.
for h in ht.HASHES:
if h.name in elt:
result.append(cls.extract_info_from_dep(elt, h))
break
else: # We never determined a hash type...
raise spack.error.SpecError("Couldn't parse dependency spec.")
else:
raise spack.error.SpecError("Couldn't parse dependency types in spec.")
return result
[docs]
@register_reader
class SpecfileV3(SpecfileV2):
SPEC_VERSION = 3
[docs]
@register_reader
class SpecfileV4(SpecfileV2):
SPEC_VERSION = 4
[docs]
@classmethod
def load(cls, data) -> Spec:
return cls._load(data)
[docs]
@register_reader
class SpecfileV5(SpecfileV4):
"""abstract_hash, compiler_flags, when and propagation are optional node/dependency keys,
used only for abstract specs. Not enforcing them is what avoids a version bump: an older
reader ignores an unknown key, and a spec file without one stays valid."""
SPEC_VERSION = 5
[docs]
@classmethod
def legacy_compiler(cls, node):
raise RuntimeError("The 'compiler' option is unexpected in specfiles at v5 or greater")
#: Alias to the latest version of specfiles
SpecfileLatest = SpecfileV5
[docs]
def specfile_reader_for_version(version: int) -> Type[SpecfileReaderBase]:
"""Get a SpecfileReader for the provided version, or raise an error."""
reader = _SPECFILE_READERS.get(version)
if not reader:
raise ValueError(f"Unknown Specfile version: {version}")
return reader
[docs]
class LazySpecCache(collections.defaultdict):
"""Cache for Specs that uses a spec_like as key, and computes lazily
the corresponding value ``Spec(spec_like``.
"""
def __init__(self):
super().__init__(Spec)
def __missing__(self, key):
value = self.default_factory(key)
self[key] = value
return value
[docs]
def save_dependency_specfiles(root: Spec, output_directory: str, dependencies: List[Spec]):
"""Given a root spec (represented as a yaml object), index it with a subset
of its dependencies, and write each dependency to a separate yaml file
in the output directory. By default, all dependencies will be written
out. To choose a smaller subset of dependencies to be written, pass a
list of package names in the dependencies parameter. If the format of the
incoming spec is not json, that can be specified with the spec_format
parameter. This can be used to convert from yaml specfiles to the
json format."""
for spec in root.traverse():
if not any(spec.satisfies(dep) for dep in dependencies):
continue
json_path = os.path.join(output_directory, f"{spec.name}.json")
with open(json_path, "w", encoding="utf-8") as fd:
fd.write(spec.to_json(hash=ht.dag_hash))
[docs]
def get_host_environment() -> Dict[str, Any]:
"""Returns a dictionary with host information (not including the os.environ)."""
host_platform = spack.platforms.host()
host_target = host_platform.default_target()
host_os = host_platform.default_operating_system()
arch_fmt = "platform={0} os={1} target={2}"
arch_spec = Spec(arch_fmt.format(host_platform, host_os, host_target))
return {
"target": str(host_target),
"os": str(host_os),
"platform": str(host_platform),
"arch": arch_spec,
"architecture": arch_spec,
"arch_str": str(arch_spec),
"hostname": socket.gethostname(),
}
[docs]
def eval_conditional(string):
"""Evaluate conditional definitions using restricted variable scope."""
valid_variables = get_host_environment()
valid_variables.update({"re": re, "env": os.environ})
return eval(string, valid_variables)
def _inject_patches_variant(root: Spec) -> None:
# This dictionary will store object IDs rather than Specs as keys
# since the Spec __hash__ will change as patches are added to them
spec_to_patches: Dict[int, Set[spack.patch.Patch]] = {}
for s in root.traverse():
assert s.namespace is not None, (
f"internal error: {s.name} has no namespace after concretization. "
f"Please report a bug at https://github.com/spack/spack/issues"
)
if s.concrete:
continue
# Add any patches from the package to the spec.
node_patches = {
patch
for cond, patch_list in spack.repo.PATH.get_pkg_class(s.fullname).patches.items()
if s.satisfies(cond)
for patch in patch_list
}
if node_patches:
spec_to_patches[id(s)] = node_patches
# Also record all patches required on dependencies by depends_on(..., patch=...)
for dspec in root.traverse_edges(deptype=dt.ALL, cover="edges", root=False):
if dspec.spec.concrete:
continue
pkg_deps = spack.repo.PATH.get_pkg_class(dspec.parent.fullname).dependencies
edge_patches: List[spack.patch.Patch] = []
for cond, deps_by_name in pkg_deps.items():
dependency = deps_by_name.get(dspec.spec.name)
if not dependency or not dependency.patches:
continue
if not dspec.parent.satisfies(cond):
continue
for pcond, patch_list in dependency.patches.items():
if dspec.spec.satisfies(pcond):
edge_patches.extend(patch_list)
if edge_patches:
spec_to_patches.setdefault(id(dspec.spec), set()).update(edge_patches)
for spec in root.traverse():
if id(spec) not in spec_to_patches:
continue
patches = list(spec_to_patches[id(spec)])
variant: vt.VariantValue = spec.variants.setdefault(
"patches", vt.MultiValuedVariant("patches", ())
)
variant.set(*(p.sha256 for p in patches))
# FIXME: Monkey patches variant to store patches order
ordered_hashes = [(*p.ordering_key, p.sha256) for p in patches if p.ordering_key]
ordered_hashes.sort()
tty.debug(
f"Ordered hashes [{spec.name}]: "
+ ", ".join("/".join(str(e) for e in t) for t in ordered_hashes)
)
setattr(
variant, "_patches_in_order_of_appearance", [sha256 for _, _, sha256 in ordered_hashes]
)
[docs]
class InvalidVariantForSpecError(spack.error.SpecError):
"""Raised when an invalid conditional variant is specified."""
def __init__(self, variant, when, spec):
msg = f"Invalid variant {variant} for spec {spec}.\n"
msg += f"{variant} is only available for {spec.name} when satisfying one of {when}."
super().__init__(msg)
[docs]
class UnsupportedPropagationError(spack.error.SpecError):
"""Raised when propagation (==) is used with reserved variant names."""
[docs]
class UnsupportedCompilerError(spack.error.SpecError):
"""Raised when the user asks for a compiler spack doesn't know about."""
[docs]
class DuplicateArchitectureError(spack.error.SpecError):
"""Raised when the same architecture occurs in a spec twice."""
[docs]
class InvalidDependencyError(spack.error.SpecError):
"""Raised when a dependency in a spec is not actually a dependency
of the package."""
def __init__(self, pkg, deps):
self.invalid_deps = deps
super().__init__(
"Package {0} does not depend on {1}".format(pkg, spack.util.string.comma_or(deps))
)
[docs]
class UnsatisfiableSpecNameError(spack.error.UnsatisfiableSpecError):
"""Raised when two specs aren't even for the same package."""
def __init__(self, provided, required):
super().__init__(provided, required, "name")
[docs]
class UnsatisfiableVersionSpecError(spack.error.UnsatisfiableSpecError):
"""Raised when a spec version conflicts with package constraints."""
def __init__(self, provided, required):
super().__init__(provided, required, "version")
[docs]
class UnsatisfiableArchitectureSpecError(spack.error.UnsatisfiableSpecError):
"""Raised when a spec architecture conflicts with package constraints."""
def __init__(self, provided, required):
super().__init__(provided, required, "architecture")
# TODO: get rid of this and be more specific about particular incompatible
# dep constraints
[docs]
class UnsatisfiableDependencySpecError(spack.error.UnsatisfiableSpecError):
"""Raised when some dependency of constrained specs are incompatible"""
def __init__(self, provided, required):
super().__init__(provided, required, "dependency")
[docs]
class AmbiguousHashError(spack.error.SpecError):
def __init__(self, msg, *specs):
spec_fmt = (
"{namespace}.{name}{@version}{variants}"
"{ platform=architecture.platform}{ os=architecture.os}{ target=architecture.target}"
"{/hash:7}"
)
specs_str = "\n " + "\n ".join(spec.format(spec_fmt) for spec in specs)
super().__init__(msg + specs_str)
[docs]
class InvalidHashError(spack.error.SpecError):
def __init__(self, spec, hash):
msg = f"No spec with hash {hash} could be found to match {spec}."
msg += " Either the hash does not exist, or it does not match other spec constraints."
super().__init__(msg)
[docs]
class SpecDeprecatedError(spack.error.SpecError):
"""Raised when a spec concretizes to a deprecated spec or dependency."""
[docs]
class SpliceError(spack.error.SpecError):
"""Raised when a splice is not possible due to dependency or provider
satisfaction mismatch. The resulting splice would be unusable."""
[docs]
class InvalidEdgeError(spack.error.SpecError):
"""Raised when an edge doesn't pass validation checks."""
[docs]
class SpecMutationError(spack.error.SpecError):
"""Raised when a mutation is attempted with invalid attributes."""
[docs]
class MissingSpecHashError(spack.error.SpecError):
"""Raised when a serialized spec node references a hash not present in a node list."""
class _ImmutableSpec(Spec):
"""An immutable Spec that prevents a class of accidental mutations."""
_mutable: bool
_str_cache: str
def __init__(self, spec_like: Optional[str] = None) -> None:
object.__setattr__(self, "_mutable", True)
super().__init__(spec_like)
object.__delattr__(self, "_mutable")
def __setstate__(self, state) -> None:
object.__setattr__(self, "_mutable", True)
super().__setstate__(state)
object.__delattr__(self, "_mutable")
def constrain(self, *args, **kwargs) -> bool:
assert self._mutable
return super().constrain(*args, **kwargs)
def add_dependency_edge(self, *args, **kwargs):
assert self._mutable
return super().add_dependency_edge(*args, **kwargs)
def __str__(self) -> str:
# Cache the str value of immutable specs as an optimization
try:
return self._str_cache
except AttributeError:
s = self._str(color=False)
object.__setattr__(self, "_str_cache", s)
return s
def __setattr__(self, name, value) -> None:
assert self._mutable
super().__setattr__(name, value)
def __delattr__(self, name) -> None:
assert self._mutable
object.__delattr__(self, name)
#: Immutable empty spec, for fast comparisons and reduced memory usage.
EMPTY_SPEC = _ImmutableSpec()