flamapy 2.6.0.dev2__tar.gz → 2.6.0.dev4__tar.gz

{flamapy-2.6.0.dev2 → flamapy-2.6.0.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flamapy
-Version: 2.6.0.dev2
+Version: 2.6.0.dev4
 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,11 +8,11 @@ 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.dev2
-Requires-Dist: flamapy-fm~=2.6.0.dev2
-Requires-Dist: flamapy-sat~=2.6.0.dev2
-Requires-Dist: flamapy-bdd~=2.6.0.dev2
-Requires-Dist: flamapy-z3~=2.6.0.dev2
+Requires-Dist: flamapy-fw~=2.6.0.dev4
+Requires-Dist: flamapy-fm~=2.6.0.dev4
+Requires-Dist: flamapy-sat~=2.6.0.dev4
+Requires-Dist: flamapy-bdd~=2.6.0.dev4
+Requires-Dist: flamapy-z3~=2.6.0.dev4
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-mock; extra == "dev"

{flamapy-2.6.0.dev2 → flamapy-2.6.0.dev4}/flamapy/interfaces/python/flamapy_feature_model.py

@@ -90,6 +90,24 @@ class FLAMAFeatureModel:
                 self.fm_model, "pysat_diagnosis"
             )
 
+    def _as_configuration(
+        self, configuration: Union[str, Dict[str, Any], Configuration]
+    ) -> Configuration:
+        """Resolve a configuration argument into a Configuration model.
+
+        Accepts a path to a configuration file (read via the configuration
+        transformation), a ``{feature: value}`` mapping, or an already-built
+        Configuration. This lets callers that already hold a configuration in
+        memory (e.g. an interactive UI) pass it directly without writing a file.
+        """
+        if isinstance(configuration, Configuration):
+            return configuration
+        if isinstance(configuration, dict):
+            return Configuration(configuration)
+        return self.discover_metamodel.use_transformation_t2m(
+            configuration, "configuration"
+        )
+
     def atomic_sets(self) -> Union[None, List[List[Any]]]:
         """
         This operation is used to find the atomic sets in a model:
@@ -297,12 +315,13 @@ class FLAMAFeatureModel:
         This operation selects a subset of the products of a product line based on certain
         criteria. For example, you might filter the products to only include those that
         contain a certain feature.
+
+        ``configuration_path`` accepts a configuration file path, a ``{feature: value}``
+        mapping, or a Configuration object.
         """
         try:
             self._transform_to_sat()
-            configuration = self.discover_metamodel.use_transformation_t2m(
-                configuration_path, "configuration"
-            )
+            configuration = self._as_configuration(configuration_path)
             operation = self.discover_metamodel.get_operation(self.sat_model, "PySATFilter")
             operation.set_configuration(configuration)
             operation.execute(self.sat_model)
@@ -350,12 +369,13 @@ class FLAMAFeatureModel:
         This is a measure of how often a feature appears in the products of a
         product line. It's usually expressed as a percentage. A feature with
         100 per cent commonality is a core feature, as it appears in all products.
+
+        ``configuration_path`` accepts a configuration file path, a ``{feature: value}``
+        mapping, or a Configuration object.
         """
         try:
             self._transform_to_sat()
-            configuration = self.discover_metamodel.use_transformation_t2m(
-                configuration_path, "configuration"
-            )
+            configuration = self._as_configuration(configuration_path)
 
             operation = self.discover_metamodel.get_operation(self.sat_model, "PySATCommonality")
             operation.set_configuration(configuration)
@@ -375,13 +395,13 @@ class FLAMAFeatureModel:
         This is a product that is produced from a valid configuration of features. A valid
         product satisfies all the constraints and dependencies in the feature model.
 
+        ``configuration_path`` accepts a configuration file path, a ``{feature: value}``
+        mapping, or a Configuration object.
         ``backend`` selects the analysis plugin ("sat", "bdd" or "z3"); defaults to sat.
         """
         try:
             model = self._select_backend(backend, Backend.SAT)
-            configuration = self.discover_metamodel.use_transformation_t2m(
-                configuration_path, "configuration"
-            )
+            configuration = self._as_configuration(configuration_path)
             operation = self.discover_metamodel.get_operation(
                 model, "SatisfiableConfiguration"
             )
@@ -635,27 +655,27 @@ class FLAMAFeatureModel:
     def diagnosis(
         self,
         configuration_path: str,
-        test_case_path: str,
+        test_case_path: Optional[str] = None,
         max_diagnoses: Optional[int] = None,
     ) -> Union[None, List[str]]:
         """
-        Returns a list of diagnoses explaining why a given configuration does not satisfy
-        the test case constraints. Each diagnosis is a minimal set of constraints whose
-        removal would resolve the inconsistency. Requires the pysat_diagnosis plugin.
+        Returns a list of diagnoses explaining why a configuration is not valid against the
+        feature model: each diagnosis is a minimal set of constraints whose removal would
+        resolve the inconsistency. Requires the pysat_diagnosis plugin.
+
+        ``configuration_path`` accepts a configuration file path, a ``{feature: value}``
+        mapping, or a Configuration object. ``test_case_path`` is optional and, when given,
+        diagnoses against that expected outcome instead; it accepts the same input types.
         """
         try:
             self._transform_to_diagnosis()
-            configuration = self.discover_metamodel.use_transformation_t2m(
-                configuration_path, "configuration"
-            )
-            test_case = self.discover_metamodel.use_transformation_t2m(
-                test_case_path, "configuration"
-            )
             operation = self.discover_metamodel.get_operation(
                 self.diagnosis_model, "PySATDiagnosis"
             )
-            operation.set_configuration(configuration)
-            operation.set_test_case(test_case)
+            if configuration_path is not None:
+                operation.set_configuration(self._as_configuration(configuration_path))
+            if test_case_path is not None:
+                operation.set_test_case(self._as_configuration(test_case_path))
             if max_diagnoses is not None:
                 operation.set_max_diagnoses(max_diagnoses)
             operation.execute(self.diagnosis_model)
@@ -667,27 +687,26 @@ class FLAMAFeatureModel:
     def conflict(
         self,
         configuration_path: str,
-        test_case_path: str,
+        test_case_path: Optional[str] = None,
         max_conflicts: Optional[int] = None,
     ) -> Union[None, List[str]]:
         """
         Returns a list of conflict sets: minimal subsets of the model constraints that are
-        inconsistent with the given configuration and test case. Requires the pysat_diagnosis
-        plugin.
+        inconsistent with the given configuration. Requires the pysat_diagnosis plugin.
+
+        ``configuration_path`` accepts a configuration file path, a ``{feature: value}``
+        mapping, or a Configuration object. ``test_case_path`` is optional and, when given,
+        looks for conflicts against that expected outcome instead; same input types.
         """
         try:
             self._transform_to_diagnosis()
-            configuration = self.discover_metamodel.use_transformation_t2m(
-                configuration_path, "configuration"
-            )
-            test_case = self.discover_metamodel.use_transformation_t2m(
-                test_case_path, "configuration"
-            )
             operation = self.discover_metamodel.get_operation(
                 self.diagnosis_model, "PySATConflict"
             )
-            operation.set_configuration(configuration)
-            operation.set_test_case(test_case)
+            if configuration_path is not None:
+                operation.set_configuration(self._as_configuration(configuration_path))
+            if test_case_path is not None:
+                operation.set_test_case(self._as_configuration(test_case_path))
             if max_conflicts is not None:
                 operation.set_max_conflicts(max_conflicts)
             operation.execute(self.diagnosis_model)

{flamapy-2.6.0.dev2 → flamapy-2.6.0.dev4}/flamapy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flamapy
-Version: 2.6.0.dev2
+Version: 2.6.0.dev4
 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,11 +8,11 @@ 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.dev2
-Requires-Dist: flamapy-fm~=2.6.0.dev2
-Requires-Dist: flamapy-sat~=2.6.0.dev2
-Requires-Dist: flamapy-bdd~=2.6.0.dev2
-Requires-Dist: flamapy-z3~=2.6.0.dev2
+Requires-Dist: flamapy-fw~=2.6.0.dev4
+Requires-Dist: flamapy-fm~=2.6.0.dev4
+Requires-Dist: flamapy-sat~=2.6.0.dev4
+Requires-Dist: flamapy-bdd~=2.6.0.dev4
+Requires-Dist: flamapy-z3~=2.6.0.dev4
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-mock; extra == "dev"

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

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

{flamapy-2.6.0.dev2 → flamapy-2.6.0.dev4}/pyproject.toml

@@ -4,18 +4,18 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "flamapy"
-version = "2.6.0.dev2"
+version = "2.6.0.dev4"
 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.dev2",
-    "flamapy-fm~=2.6.0.dev2",
-    "flamapy-sat~=2.6.0.dev2",
-    "flamapy-bdd~=2.6.0.dev2",
-    "flamapy-z3~=2.6.0.dev2",
+    "flamapy-fw~=2.6.0.dev4",
+    "flamapy-fm~=2.6.0.dev4",
+    "flamapy-sat~=2.6.0.dev4",
+    "flamapy-bdd~=2.6.0.dev4",
+    "flamapy-z3~=2.6.0.dev4",
 ]
 
 [project.optional-dependencies]

{flamapy-2.6.0.dev2 → flamapy-2.6.0.dev4}/tests/test_basic_units.py

@@ -7,6 +7,14 @@ VALID_MODEL = "./resources/models/simple/valid_model.uvl"
 NON_VALID_MODEL = "./resources/models/simple/invalid_model.uvl"
 
 VALID_CONFIG = "./resources/configurations/valid_configuration.csvconf"
+# Same configuration as VALID_CONFIG, expressed as an in-memory mapping. Config
+# operations accept a path, a {feature: value} mapping, or a Configuration object.
+VALID_CONFIG_DICT = {
+    "eCommerce": True, "Server": True, "PHP": True, "v74": True, "Storage": True,
+    "LOW": True, "Web": True, "Catalog": True, "Search": True, "BASIC": True,
+    "Shopping": True, "Cart": True, "Payment": True, "PayPal": True,
+    "Security": True, "HIGH": True,
+}
 
 
 def test_atomic_sets():
@@ -239,6 +247,15 @@ def test_valid_configuration():
     assert result == True
 
 
+def test_config_operations_accept_mapping():
+    # Config operations accept an in-memory {feature: value} mapping and must
+    # produce the same result as reading the equivalent configuration file.
+    flamafm = FLAMAFeatureModel(VALID_MODEL)
+
+    assert flamafm.filter(VALID_CONFIG_DICT) == flamafm.filter(VALID_CONFIG)
+    assert flamafm.satisfiable_configuration(VALID_CONFIG_DICT, False) is True
+
+
 def test_valid_product():
     # Prepare
     flamafm = FLAMAFeatureModel(VALID_MODEL)

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

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