flamapy 2.6.0.dev3__tar.gz → 2.6.0.dev5__tar.gz

{flamapy-2.6.0.dev3 → flamapy-2.6.0.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flamapy
-Version: 2.6.0.dev3
+Version: 2.6.0.dev5
 Summary: Flamapy feature model is a distribution of the flama framework containing all plugins required to analyze feature models. It also offers a richer API and a complete command line interface and documentation.
 Author-email: Flamapy <flamapy@us.es>
 License-Expression: GPL-3.0-or-later
@@ -8,17 +8,19 @@ Project-URL: Homepage, https://github.com/flamapy/flamapy-feature-model
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: flamapy-fw~=2.6.0.dev3
-Requires-Dist: flamapy-fm~=2.6.0.dev3
-Requires-Dist: flamapy-sat~=2.6.0.dev3
-Requires-Dist: flamapy-bdd~=2.6.0.dev3
-Requires-Dist: flamapy-z3~=2.6.0.dev3
+Requires-Dist: flamapy-fw~=2.6.0.dev5
+Requires-Dist: flamapy-fm~=2.6.0.dev5
+Requires-Dist: flamapy-sat~=2.6.0.dev5
+Requires-Dist: flamapy-bdd~=2.6.0.dev5
+Requires-Dist: flamapy-z3~=2.6.0.dev5
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-mock; extra == "dev"
 Requires-Dist: prospector; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
+Provides-Extra: sharpsat
+Requires-Dist: flamapy-sharpsat~=2.6.0.dev4; extra == "sharpsat"
 Dynamic: license-file
 
 # flamapy

{flamapy-2.6.0.dev3 → flamapy-2.6.0.dev5}/flamapy/commands/__init__.py

@@ -5,7 +5,7 @@ from functools import wraps
 import inspect
 from pathlib import Path
 from shutil import copytree
-from typing import Any, List, Tuple, Optional
+from typing import Any, List, Tuple, Optional, Union, get_args, get_origin
 from types import FunctionType
 
 from flamapy.interfaces.python.flamapy_feature_model import FLAMAFeatureModel
@@ -92,30 +92,43 @@ def generate_plugin(args):  # type: ignore
     print("Plugin generated!")
 
 
+def resolve_annotation_type(annotation: Any) -> type:
+    """Map a parameter annotation to a concrete type usable as an argparse 'type'.
+
+    Unwraps Optional[X]/Union[X, None] to X; falls back to str for anything
+    that is not a plain class (argparse requires a callable).
+    """
+    if annotation is inspect.Parameter.empty:
+        return str
+    if get_origin(annotation) is Union:
+        args = [arg for arg in get_args(annotation) if arg is not type(None)]
+        annotation = args[0] if args else str
+    return annotation if isinstance(annotation, type) else str
+
+
 def setup_dynamic_commands(subparsers, dynamic_commands):  # type: ignore
     for name, docstring, method, parameters in dynamic_commands:
         subparser = subparsers.add_parser(name, help=docstring)
         subparser.add_argument("model_path", type=str, help="Path to the feature model file")
-        if "configuration_path" in [param.name for param in parameters]:
-            subparser.add_argument(
-                "--configuration_path",
-                type=str,
-                help="Path to the configuration file",
-                required=False,
-            )
         for param in parameters:
             arg_name = param.name
             if arg_name not in ["model_path"]:  # Avoid duplicates
+                arg_type = resolve_annotation_type(param.annotation)
                 if param.default == param.empty:  # Positional argument
+                    subparser.add_argument(arg_name, type=arg_type, help=arg_type.__name__)
+                elif arg_type is bool:  # Boolean flag (type=bool would parse 'False' as True)
                     subparser.add_argument(
-                        arg_name, type=param.annotation, help=param.annotation.__name__
+                        f"--{arg_name}",
+                        action=argparse.BooleanOptionalAction,
+                        default=param.default,
+                        help="Optional bool",
                     )
                 else:  # Optional argument
                     subparser.add_argument(
                         f"--{arg_name}",
-                        type=param.annotation,
+                        type=arg_type,
                         default=param.default,
-                        help=f"Optional {param.annotation.__name__}",
+                        help=f"Optional {arg_type.__name__}",
                     )
         subparser.set_defaults(func=method, method_name=name, parameters=parameters)
 

{flamapy-2.6.0.dev3 → flamapy-2.6.0.dev5}/flamapy/interfaces/python/flamapy_feature_model.py

@@ -5,6 +5,7 @@ from flamapy.core.discover import DiscoverMetamodels
 from flamapy.core.models import VariabilityModel
 from flamapy.metamodels.fm_metamodel.models import FeatureModel
 from flamapy.core.exceptions import FlamaException
+from flamapy.core.operations import OptimizationGoal
 from flamapy.metamodels.configuration_metamodel.models import Configuration
 
 logger = logging.getLogger(__name__)
@@ -16,6 +17,7 @@ class Backend(str, Enum):
     SAT = "sat"
     BDD = "bdd"
     Z3 = "z3"
+    SHARPSAT = "sharpsat"
 
 
 class FLAMAFeatureModel:
@@ -24,6 +26,7 @@ class FLAMAFeatureModel:
         Backend.SAT: ("_transform_to_sat", "sat_model"),
         Backend.BDD: ("_transform_to_bdd", "bdd_model"),
         Backend.Z3: ("_transform_to_z3", "z3_model"),
+        Backend.SHARPSAT: ("_transform_to_sharpsat", "sharpsat_model"),
     }
 
     def __init__(self, model_path: str, backend: Optional[str] = None):
@@ -42,6 +45,7 @@ class FLAMAFeatureModel:
         self.sat_model = None
         self.bdd_model = None
         self.z3_model = None
+        self.sharpsat_model = None
         self.diagnosis_model = None
         self.backend = Backend(backend) if backend is not None else None
 
@@ -84,6 +88,14 @@ class FLAMAFeatureModel:
         if self.z3_model is None:
             self.z3_model = self.discover_metamodel.use_transformation_m2m(self.fm_model, "z3")
 
+    def _transform_to_sharpsat(self) -> None:
+        if self.sharpsat_model is None:
+            # Requires the optional flamapy-sharpsat plugin. use_transformation_m2m raises a
+            # FlamaException if it is not installed, which the operations surface to the caller.
+            self.sharpsat_model = self.discover_metamodel.use_transformation_m2m(
+                self.fm_model, "sharpsat"
+            )
+
     def _transform_to_diagnosis(self) -> None:
         if self.diagnosis_model is None:
             self.diagnosis_model = self.discover_metamodel.use_transformation_m2m(
@@ -338,7 +350,8 @@ class FLAMAFeatureModel:
         combinations of features, taking into account the constraints and
         dependencies between features.
 
-        ``backend`` selects the analysis plugin ("sat", "bdd" or "z3"); defaults to bdd.
+        ``backend`` selects the analysis plugin ("sat", "bdd", "z3", or "sharpsat" for a
+        scalable approximate count via the optional flamapy-sharpsat plugin); defaults to bdd.
         """
         try:
             model = self._select_backend(backend, Backend.BDD)
@@ -604,8 +617,9 @@ class FLAMAFeatureModel:
         Returns a random sample of valid configurations of the given size. When
         with_replacement is True, the same configuration may appear more than once.
 
-        ``backend`` selects the analysis plugin; defaults to bdd. Only sat and bdd
-        implement sampling.
+        ``backend`` selects the analysis plugin; defaults to bdd. sat and bdd implement
+        (deterministic/enumerating) sampling; "sharpsat" provides almost-uniform sampling
+        via the optional flamapy-sharpsat plugin.
         """
         try:
             model = self._select_backend(backend, Backend.BDD)
@@ -618,6 +632,76 @@ class FLAMAFeatureModel:
             logger.error("Error: %s", exception)
             return None
 
+    def t_wise_sampling(
+        self, t: int = 2, backend: Optional[str] = None
+    ) -> Union[None, List[Configuration]]:
+        """
+        Returns a t-wise (combinatorial) sample: a set of valid configurations that covers
+        every satisfiable combination of ``t`` feature selections (pairwise for ``t = 2``).
+
+        ``backend`` selects the analysis plugin; only "sat" implements t-wise sampling.
+        """
+        try:
+            model = self._select_backend(backend, Backend.SAT)
+            operation = self.discover_metamodel.get_operation(model, "PySATTWiseSampling")
+            operation.set_t(t)
+            operation.execute(model)
+            return operation.get_result()
+        except FlamaException as exception:
+            logger.error("Error: %s", exception)
+            return None
+
+    def minimum_configuration(
+        self, backend: Optional[str] = None
+    ) -> Union[None, Configuration]:
+        """
+        Returns a valid configuration with the fewest selected features (the minimum
+        working configuration).
+
+        ``backend`` selects the analysis plugin; only "sat" implements this operation.
+        """
+        try:
+            model = self._select_backend(backend, Backend.SAT)
+            operation = self.discover_metamodel.get_operation(model, "PySATMinimumConfiguration")
+            operation.execute(model)
+            return operation.get_result()
+        except FlamaException as exception:
+            logger.error("Error: %s", exception)
+            return None
+
+    def attribute_optimization(
+        self, objectives: Any, backend: Optional[str] = None
+    ) -> Union[None, List[Configuration]]:
+        """
+        Returns the configuration(s) that optimize one or more numeric feature attributes.
+
+        ``objectives`` is either a single attribute name (defaults to minimizing it) or a
+        mapping ``{attribute_name: "Minimize"|"Maximize"}``. ``backend`` selects the plugin:
+        "sat" performs single-objective MaxSAT optimization; "z3" additionally supports
+        typed attributes and multi-objective (Pareto) optimization. Defaults to "sat".
+        """
+        def _goal(value: Any) -> OptimizationGoal:
+            return (OptimizationGoal.MINIMIZE
+                    if str(value).lower().startswith('min')
+                    else OptimizationGoal.MAXIMIZE)
+
+        if isinstance(objectives, str):
+            attributes = {objectives: OptimizationGoal.MINIMIZE}
+        else:
+            attributes = {name: _goal(goal) for name, goal in dict(objectives).items()}
+
+        try:
+            model = self._select_backend(backend, Backend.SAT)
+            operation = self.discover_metamodel.get_operation(model, "AttributeOptimization")
+            operation.set_attributes(attributes)
+            operation.execute(model)
+            # z3 returns (configuration, values) tuples; sat returns configurations.
+            return [item[0] if isinstance(item, tuple) else item
+                    for item in operation.get_result()]
+        except FlamaException as exception:
+            logger.error("Error: %s", exception)
+            return None
+
     # Z3-based operations
 
     def all_feature_bounds(self) -> Union[None, Dict[str, Dict[str, Any]]]:

{flamapy-2.6.0.dev3 → flamapy-2.6.0.dev5}/flamapy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flamapy
-Version: 2.6.0.dev3
+Version: 2.6.0.dev5
 Summary: Flamapy feature model is a distribution of the flama framework containing all plugins required to analyze feature models. It also offers a richer API and a complete command line interface and documentation.
 Author-email: Flamapy <flamapy@us.es>
 License-Expression: GPL-3.0-or-later
@@ -8,17 +8,19 @@ Project-URL: Homepage, https://github.com/flamapy/flamapy-feature-model
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: flamapy-fw~=2.6.0.dev3
-Requires-Dist: flamapy-fm~=2.6.0.dev3
-Requires-Dist: flamapy-sat~=2.6.0.dev3
-Requires-Dist: flamapy-bdd~=2.6.0.dev3
-Requires-Dist: flamapy-z3~=2.6.0.dev3
+Requires-Dist: flamapy-fw~=2.6.0.dev5
+Requires-Dist: flamapy-fm~=2.6.0.dev5
+Requires-Dist: flamapy-sat~=2.6.0.dev5
+Requires-Dist: flamapy-bdd~=2.6.0.dev5
+Requires-Dist: flamapy-z3~=2.6.0.dev5
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-mock; extra == "dev"
 Requires-Dist: prospector; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
+Provides-Extra: sharpsat
+Requires-Dist: flamapy-sharpsat~=2.6.0.dev4; extra == "sharpsat"
 Dynamic: license-file
 
 # flamapy

{flamapy-2.6.0.dev3 → flamapy-2.6.0.dev5}/flamapy.egg-info/SOURCES.txt

@@ -15,4 +15,5 @@ tests/test_basic_units.py
 tests/test_cli_basic_units.py
 tests/test_documentation_examples.py
 tests/test_fama_suite_bdd.py
-tests/test_fama_suite_sat.py
+tests/test_fama_suite_sat.py
+tests/test_new_operations.py

flamapy-2.6.0.dev5/flamapy.egg-info/requires.txt

@@ -0,0 +1,15 @@
+flamapy-fw~=2.6.0.dev5
+flamapy-fm~=2.6.0.dev5
+flamapy-sat~=2.6.0.dev5
+flamapy-bdd~=2.6.0.dev5
+flamapy-z3~=2.6.0.dev5
+
+[dev]
+pytest
+pytest-mock
+prospector
+mypy
+coverage
+
+[sharpsat]
+flamapy-sharpsat~=2.6.0.dev4

{flamapy-2.6.0.dev3 → flamapy-2.6.0.dev5}/pyproject.toml

@@ -4,18 +4,18 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "flamapy"
-version = "2.6.0.dev3"
+version = "2.6.0.dev5"
 description = "Flamapy feature model is a distribution of the flama framework containing all plugins required to analyze feature models. It also offers a richer API and a complete command line interface and documentation."
 readme = "README.md"
 license = "GPL-3.0-or-later"
 authors = [{ name = "Flamapy", email = "flamapy@us.es" }]
 requires-python = ">=3.11"
 dependencies = [
-    "flamapy-fw~=2.6.0.dev3",
-    "flamapy-fm~=2.6.0.dev3",
-    "flamapy-sat~=2.6.0.dev3",
-    "flamapy-bdd~=2.6.0.dev3",
-    "flamapy-z3~=2.6.0.dev3",
+    "flamapy-fw~=2.6.0.dev5",
+    "flamapy-fm~=2.6.0.dev5",
+    "flamapy-sat~=2.6.0.dev5",
+    "flamapy-bdd~=2.6.0.dev5",
+    "flamapy-z3~=2.6.0.dev5",
 ]
 
 [project.optional-dependencies]
@@ -26,6 +26,10 @@ dev = [
     "mypy",
     "coverage",
 ]
+# Optional scalable counting/sampling backend (enables backend="sharpsat").
+sharpsat = [
+    "flamapy-sharpsat~=2.6.0.dev4",
+]
 
 [project.scripts]
 flamapy = "flamapy.commands:flamapy_cli"

{flamapy-2.6.0.dev3 → flamapy-2.6.0.dev5}/tests/test_basic_units.py

@@ -233,7 +233,7 @@ def test_commonality():
     result = flamafm.commonality(VALID_CONFIG)
 
     # Assert
-    assert 0.0 == 0.0
+    assert result == 1.0
 
 
 def test_valid_configuration():

flamapy-2.6.0.dev5/tests/test_new_operations.py

@@ -0,0 +1,110 @@
+"""Facade tests for the newly exposed operations: attribute optimization, minimum
+configuration, t-wise sampling, and the sharpsat backend."""
+import itertools
+import os
+import tempfile
+
+import pytest
+
+from flamapy.interfaces.python.flamapy_feature_model import FLAMAFeatureModel
+
+_ATTRIBUTED_UVL = """features
+    Root {abstract}
+        optional
+            A {Cost 3}
+            B {Cost 5}
+            C {Cost 2}
+constraints
+    A | B
+"""
+
+_PLAIN_UVL = """features
+    Root {abstract}
+        optional
+            A
+            B
+            C
+            D
+constraints
+    (A | B) => (C <=> D)
+    A => !B
+"""
+
+
+def _model(uvl):
+    handle, path = tempfile.mkstemp(suffix='.uvl')
+    with os.fdopen(handle, 'w') as file:
+        file.write(uvl)
+    return path
+
+
+def _sel(configuration):
+    return {name for name, value in configuration.elements.items() if value}
+
+
+# --- attribute optimization -------------------------------------------------
+
+def test_attribute_optimization_sat_minimize():
+    fm = FLAMAFeatureModel(_model(_ATTRIBUTED_UVL))
+    result = fm.attribute_optimization("Cost", backend="sat")
+    assert [_sel(c) for c in result] == [{"A", "Root"}]
+
+
+def test_attribute_optimization_sat_maximize():
+    fm = FLAMAFeatureModel(_model(_ATTRIBUTED_UVL))
+    result = fm.attribute_optimization({"Cost": "Maximize"}, backend="sat")
+    assert [_sel(c) for c in result] == [{"A", "B", "C", "Root"}]
+
+
+def test_attribute_optimization_sat_matches_z3():
+    path = _model(_ATTRIBUTED_UVL)
+    sat = FLAMAFeatureModel(path).attribute_optimization({"Cost": "Minimize"}, backend="sat")
+    z3 = FLAMAFeatureModel(path).attribute_optimization({"Cost": "Minimize"}, backend="z3")
+    assert {frozenset(_sel(c)) for c in sat} == {frozenset(_sel(c)) for c in z3}
+
+
+# --- minimum configuration --------------------------------------------------
+
+def test_minimum_configuration():
+    # The attributed model has an "A | B" constraint, so the minimum working
+    # configuration is Root plus exactly one of A/B.
+    fm = FLAMAFeatureModel(_model(_ATTRIBUTED_UVL))
+    selected = _sel(fm.minimum_configuration(backend="sat"))
+    assert "Root" in selected
+    assert len(selected) == 2 and len(selected & {"A", "B"}) == 1
+
+
+# --- t-wise sampling --------------------------------------------------------
+
+def test_t_wise_sampling_covers_valid_pairs():
+    fm = FLAMAFeatureModel(_model(_PLAIN_UVL))
+    sample = fm.t_wise_sampling(2, backend="sat")
+    selected_sets = [_sel(c) for c in sample]
+    # every satisfiable pair is covered; A&B is unsatisfiable (A => !B) so may be absent.
+    features = ["A", "B", "C", "D"]
+    for f1, f2 in itertools.combinations(features, 2):
+        for v1, v2 in itertools.product((True, False), repeat=2):
+            covered = any((f1 in s) == v1 and (f2 in s) == v2 for s in selected_sets)
+            if not covered:
+                assert (f1, f2, v1, v2) == ("A", "B", True, True)
+
+
+# --- sharpsat backend -------------------------------------------------------
+
+def test_sharpsat_backend_count_matches_bdd():
+    path = _model(_PLAIN_UVL)
+    exact = FLAMAFeatureModel(path).configurations_number(backend="bdd")
+    approx = FLAMAFeatureModel(path).configurations_number(backend="sharpsat")
+    assert approx == exact
+
+
+def test_sharpsat_backend_sampling_returns_valid_configurations():
+    path = _model(_PLAIN_UVL)
+    fm = FLAMAFeatureModel(path)
+    sample = fm.sampling(6, with_replacement=True, backend="sharpsat")
+    assert len(sample) == 6
+    # each sampled configuration is a valid full configuration
+    for configuration in sample:
+        elements = {f.name: (f.name in _sel(configuration))
+                    for f in FLAMAFeatureModel(path).fm_model.get_features()}
+        assert FLAMAFeatureModel(path).satisfiable_configuration(elements) is True

flamapy-2.6.0.dev3/flamapy.egg-info/requires.txt

@@ -1,12 +0,0 @@
-flamapy-fw~=2.6.0.dev3
-flamapy-fm~=2.6.0.dev3
-flamapy-sat~=2.6.0.dev3
-flamapy-bdd~=2.6.0.dev3
-flamapy-z3~=2.6.0.dev3
-
-[dev]
-pytest
-pytest-mock
-prospector
-mypy
-coverage