|
| 1 | +r""" |
| 2 | +Join features |
| 3 | +""" |
| 4 | + |
| 5 | +from . import Feature, FeatureTestResult |
| 6 | + |
| 7 | + |
| 8 | +class JoinFeature(Feature): |
| 9 | + r""" |
| 10 | + Join of several :class:`sage.features.Feature` instances. |
| 11 | +
|
| 12 | + EXAMPLES:: |
| 13 | +
|
| 14 | + sage: from sage.features import Executable |
| 15 | + sage: from sage.features.join_feature import JoinFeature |
| 16 | + sage: F = JoinFeature("shell-boolean", |
| 17 | + ....: (Executable('shell-true', 'true'), |
| 18 | + ....: Executable('shell-false', 'false'))) |
| 19 | + sage: F.is_present() |
| 20 | + FeatureTestResult('shell-boolean', True) |
| 21 | + sage: F = JoinFeature("asdfghjkl", |
| 22 | + ....: (Executable('shell-true', 'true'), |
| 23 | + ....: Executable('xxyyyy', 'xxyyyy-does-not-exist'))) |
| 24 | + sage: F.is_present() |
| 25 | + FeatureTestResult('xxyyyy', False) |
| 26 | + """ |
| 27 | + def __init__(self, name, features, spkg=None, url=None): |
| 28 | + """ |
| 29 | + TESTS: |
| 30 | +
|
| 31 | + The empty join feature is present:: |
| 32 | +
|
| 33 | + sage: from sage.features.join_feature import JoinFeature |
| 34 | + sage: JoinFeature("empty", ()).is_present() |
| 35 | + FeatureTestResult('empty', True) |
| 36 | + """ |
| 37 | + if spkg is None: |
| 38 | + spkgs = set(f.spkg for f in features if f.spkg) |
| 39 | + if len(spkgs) > 1: |
| 40 | + raise ValueError('given features have more than one spkg; provide spkg argument') |
| 41 | + elif len(spkgs) == 1: |
| 42 | + spkg = next(iter(spkgs)) |
| 43 | + if url is None: |
| 44 | + urls = set(f.url for f in features if f.url) |
| 45 | + if len(urls) > 1: |
| 46 | + raise ValueError('given features have more than one url; provide url argument') |
| 47 | + elif len(urls) == 1: |
| 48 | + url = next(iter(urls)) |
| 49 | + super().__init__(name, spkg=spkg, url=url) |
| 50 | + self._features = features |
| 51 | + |
| 52 | + def _is_present(self): |
| 53 | + r""" |
| 54 | + Test for the presence of the join feature. |
| 55 | +
|
| 56 | + EXAMPLES:: |
| 57 | +
|
| 58 | + sage: from sage.features.latte import Latte |
| 59 | + sage: Latte()._is_present() # optional - latte_int |
| 60 | + FeatureTestResult('LattE', True) |
| 61 | + """ |
| 62 | + for f in self._features: |
| 63 | + test = f._is_present() |
| 64 | + if not test: |
| 65 | + return test |
| 66 | + return FeatureTestResult(self, True) |
| 67 | + |
| 68 | + def is_functional(self): |
| 69 | + r""" |
| 70 | + Test whether the join feature is functional. |
| 71 | +
|
| 72 | + EXAMPLES:: |
| 73 | +
|
| 74 | + sage: from sage.features.latte import Latte |
| 75 | + sage: Latte().is_functional() # optional - latte_int |
| 76 | + FeatureTestResult('LattE', True) |
| 77 | + """ |
| 78 | + for f in self._features: |
| 79 | + test = f.is_functional() |
| 80 | + if not test: |
| 81 | + return test |
| 82 | + return FeatureTestResult(self, True) |
0 commit comments