uvllang 0.1.0__tar.gz

uvllang-0.1.0/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

uvllang-0.1.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.4
+Name: uvllang
+Version: 0.1.0
+Summary: Parser for Universal Variability Language (UVL) with CNF conversion support
+Author-email: UVL Team <jagalindo@us.es>
+License-Expression: LGPL-3.0-or-later
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: antlr4-python3-runtime==4.13.1
+Requires-Dist: sympy>=1.12
+Requires-Dist: python-sat>=0.1.8.dev13
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: antlr4-tools>=0.2.0; extra == "dev"
+Dynamic: license-file
+
+# uvllang
+
+A Python parser for the Universal Variability Language (UVL). Based on ANTLR4, adopted from https://github.com/Universal-Variability-Language/uvl-parser.
+
+## Installation
+
+```bash
+pip install uvllang
+```
+
+## Usage
+
+### Parsing
+
+```python
+from uvllang.main import UVL
+
+# Parse a UVL file
+model = UVL(from_file="examples/automotive01.uvl")
+
+# Access features
+print(f"Number of features:", len(model.features))
+
+# Access constraints
+print("All constraints:", len(model.constraints))
+print("Boolean constraints:", len(model.boolean_constraints))
+print("Arithmetic constraints:", len(model.arithmetic_constraints))
+```
+
+### CNF Conversion
+
+Convert feature models to Conjunctive Normal Form (CNF) for SAT solvers:
+
+```python
+from uvllang.main import UVL
+
+# Parse UVL file
+model = UVL(from_file="model.uvl")
+
+# Convert to CNF (returns PySAT CNF object)
+cnf = model.to_cnf()
+cnf.to_file("output.dimacs")
+```
+
+### Command Line Interface
+
+```bash
+uvl2cnf --help
+
+# Basic conversion
+uvl2cnf model.uvl
+
+# Specify output file
+uvl2cnf model.uvl output.dimacs
+
+# Verbose mode (lists ignored constraints)
+uvl2cnf model.uvl -v
+```
+
+## Dependencies
+
+- `antlr4-python3-runtime`: ANTLR4 parser runtime
+- `sympy`: Symbolic mathematics for Boolean constraint processing
+- `python-sat`: SAT solver library for CNF handling
+
+## Testing
+
+```bash
+# Install development dependencies
+pip install -e .
+
+# Run tests
+python -m pytest tests/
+```
+
+## Development
+
+```bash
+# Generate parsers from grammar files
+python generate_parsers.py
+
+# Build package
+python build_package.py
+
+# Or build manually
+python -m build
+```
+
+## Citation
+
+If you use UVL in your research, please cite:
+
+```bibtex
+@article{UVL2024,
+  title     = {UVL: Feature modelling with the Universal Variability Language},
+  journal   = {Journal of Systems and Software},
+  volume    = {225},
+  pages     = {112326},
+  year      = {2025},
+  doi       = {https://doi.org/10.1016/j.jss.2024.112326},
+  author    = {David Benavides and Chico Sundermann and Kevin Feichtinger and José A. Galindo and Rick Rabiser and Thomas Thüm}
+}
+```
+
+## Links
+
+- [UVL Models Repository](https://github.com/Universal-Variability-Language/uvl-models)
+- [UVL Website](https://universal-variability-language.github.io/)

uvllang-0.1.0/README.md

@@ -0,0 +1,108 @@
+# uvllang
+
+A Python parser for the Universal Variability Language (UVL). Based on ANTLR4, adopted from https://github.com/Universal-Variability-Language/uvl-parser.
+
+## Installation
+
+```bash
+pip install uvllang
+```
+
+## Usage
+
+### Parsing
+
+```python
+from uvllang.main import UVL
+
+# Parse a UVL file
+model = UVL(from_file="examples/automotive01.uvl")
+
+# Access features
+print(f"Number of features:", len(model.features))
+
+# Access constraints
+print("All constraints:", len(model.constraints))
+print("Boolean constraints:", len(model.boolean_constraints))
+print("Arithmetic constraints:", len(model.arithmetic_constraints))
+```
+
+### CNF Conversion
+
+Convert feature models to Conjunctive Normal Form (CNF) for SAT solvers:
+
+```python
+from uvllang.main import UVL
+
+# Parse UVL file
+model = UVL(from_file="model.uvl")
+
+# Convert to CNF (returns PySAT CNF object)
+cnf = model.to_cnf()
+cnf.to_file("output.dimacs")
+```
+
+### Command Line Interface
+
+```bash
+uvl2cnf --help
+
+# Basic conversion
+uvl2cnf model.uvl
+
+# Specify output file
+uvl2cnf model.uvl output.dimacs
+
+# Verbose mode (lists ignored constraints)
+uvl2cnf model.uvl -v
+```
+
+## Dependencies
+
+- `antlr4-python3-runtime`: ANTLR4 parser runtime
+- `sympy`: Symbolic mathematics for Boolean constraint processing
+- `python-sat`: SAT solver library for CNF handling
+
+## Testing
+
+```bash
+# Install development dependencies
+pip install -e .
+
+# Run tests
+python -m pytest tests/
+```
+
+## Development
+
+```bash
+# Generate parsers from grammar files
+python generate_parsers.py
+
+# Build package
+python build_package.py
+
+# Or build manually
+python -m build
+```
+
+## Citation
+
+If you use UVL in your research, please cite:
+
+```bibtex
+@article{UVL2024,
+  title     = {UVL: Feature modelling with the Universal Variability Language},
+  journal   = {Journal of Systems and Software},
+  volume    = {225},
+  pages     = {112326},
+  year      = {2025},
+  doi       = {https://doi.org/10.1016/j.jss.2024.112326},
+  author    = {David Benavides and Chico Sundermann and Kevin Feichtinger and José A. Galindo and Rick Rabiser and Thomas Thüm}
+}
+```
+
+## Links
+
+- [UVL Models Repository](https://github.com/Universal-Variability-Language/uvl-models)
+- [UVL Website](https://universal-variability-language.github.io/)

uvllang-0.1.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "uvllang"
+version = "0.1.0"
+description = "Parser for Universal Variability Language (UVL) with CNF conversion support"
+readme = "README.md"
+license = "LGPL-3.0-or-later"
+authors = [
+    {name = "UVL Team", email = "jagalindo@us.es"},
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.0"
+dependencies = [
+    "antlr4-python3-runtime==4.13.1",
+    "sympy>=1.12",
+    "python-sat>=0.1.8.dev13",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "antlr4-tools>=0.2.0",
+]
+
+[project.scripts]
+uvl2cnf = "uvllang.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["uvllang*"]
+exclude = ["tests*", "examples*", "grammars*"]
+
+[tool.setuptools]
+py-modules = []

uvllang-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

uvllang-0.1.0/tests/test_uvl_parser.py

@@ -0,0 +1,215 @@
+"""
+Tests for the UVL Parser package.
+"""
+
+import pytest
+import os
+import tempfile
+from uvllang.main import UVL
+
+
+class TestUVLParser:
+    """Test cases for UVL parsing functionality."""
+
+    def test_parse_automotive01_uvl(self):
+        """Test parsing the automotive01 UVL file."""
+        example_file = os.path.join(os.path.dirname(__file__), '..', 'examples', 'automotive01.uvl')
+        model = UVL(from_file=example_file)
+        
+        assert model.tree is not None
+        assert len(model.features) == 2513
+        assert model.tree.getText().startswith('namespace')
+
+    def test_parse_eshop_uvl(self):
+        """Test parsing the eshop UVL file."""
+        eshop_file = os.path.join(os.path.dirname(__file__), '..', 'examples', 'eshop.uvl')
+        model = UVL(from_file=eshop_file)
+        
+        assert model.tree is not None
+        assert len(model.features) == 173
+        assert 'eShop' in model.features
+
+    def test_parse_simple_uvl(self):
+        """Test parsing a simple UVL file."""
+        uvl_content = '''namespace TestNS
+
+features
+    Root
+        mandatory
+            FeatureA
+        optional
+            FeatureB
+'''
+        with tempfile.NamedTemporaryFile(mode='w', suffix='.uvl', delete=False) as f:
+            f.write(uvl_content)
+            temp_file = f.name
+
+        try:
+            model = UVL(from_file=temp_file)
+            assert model.tree is not None
+            assert len(model.features) == 3
+            assert 'Root' in model.features
+            assert 'FeatureA' in model.features
+            assert 'FeatureB' in model.features
+        finally:
+            os.unlink(temp_file)
+
+    def test_invalid_file_raises_error(self):
+        """Test that parsing an invalid file raises an error."""
+        invalid_content = 'This is not valid UVL syntax!'
+        
+        with tempfile.NamedTemporaryFile(mode='w', suffix='.txt', delete=False) as f:
+            f.write(invalid_content)
+            temp_file = f.name
+
+        try:
+            with pytest.raises(Exception):
+                UVL(from_file=temp_file)
+        finally:
+            os.unlink(temp_file)
+
+    def test_nonexistent_file_raises_error(self):
+        """Test that parsing a nonexistent file raises an error."""
+        with pytest.raises(FileNotFoundError):
+            UVL(from_file='nonexistent_file.uvl')
+
+
+class TestCNFConversion:
+    """Test cases for CNF conversion functionality."""
+
+    def test_cnf_eshop(self):
+        """Test CNF conversion for eshop.uvl."""
+        eshop_file = os.path.join(os.path.dirname(__file__), '..', 'examples', 'eshop.uvl')
+        model = UVL(from_file=eshop_file)
+        cnf = model.to_cnf()
+        
+        assert len(cnf.clauses) == 289
+        assert cnf.nv == 173
+        assert all(isinstance(clause, list) for clause in cnf.clauses)
+        assert all(isinstance(lit, int) for clause in cnf.clauses for lit in clause)
+
+    def test_cnf_automotive01(self):
+        """Test CNF conversion for automotive01.uvl."""
+        auto_file = os.path.join(os.path.dirname(__file__), '..', 'examples', 'automotive01.uvl')
+        model = UVL(from_file=auto_file)
+        cnf = model.to_cnf()
+        
+        assert len(cnf.clauses) == 7876  # Updated: arithmetic constraints are now properly ignored
+        assert cnf.nv == 2513
+        assert all(isinstance(clause, list) for clause in cnf.clauses)
+        assert all(isinstance(lit, int) for clause in cnf.clauses for lit in clause)
+
+    def test_cnf_root_constraint(self):
+        """Test that CNF includes root feature constraint."""
+        uvl_content = '''namespace Test
+
+features
+    Root
+        mandatory
+            Child
+'''
+        with tempfile.NamedTemporaryFile(mode='w', suffix='.uvl', delete=False) as f:
+            f.write(uvl_content)
+            temp_file = f.name
+
+        try:
+            model = UVL(from_file=temp_file)
+            cnf = model.to_cnf()
+            
+            assert [1] in cnf.clauses
+        finally:
+            os.unlink(temp_file)
+
+    def test_cnf_mandatory_constraint(self):
+        """Test that CNF correctly encodes mandatory relationships."""
+        uvl_content = '''namespace Test
+
+features
+    Root
+        mandatory
+            Child
+'''
+        with tempfile.NamedTemporaryFile(mode='w', suffix='.uvl', delete=False) as f:
+            f.write(uvl_content)
+            temp_file = f.name
+
+        try:
+            model = UVL(from_file=temp_file)
+            cnf = model.to_cnf()
+            
+            assert [1] in cnf.clauses
+            assert [-1, 2] in cnf.clauses
+            assert [-2, 1] in cnf.clauses
+        finally:
+            os.unlink(temp_file)
+
+    def test_cnf_optional_constraint(self):
+        """Test that CNF correctly encodes optional relationships."""
+        uvl_content = '''namespace Test
+
+features
+    Root
+        optional
+            OptionalChild
+'''
+        with tempfile.NamedTemporaryFile(mode='w', suffix='.uvl', delete=False) as f:
+            f.write(uvl_content)
+            temp_file = f.name
+
+        try:
+            model = UVL(from_file=temp_file)
+            cnf = model.to_cnf()
+            
+            assert [1] in cnf.clauses
+            assert [-2, 1] in cnf.clauses
+            assert [-1, 2] not in cnf.clauses
+        finally:
+            os.unlink(temp_file)
+
+    def test_cnf_xor_constraint(self):
+        """Test that CNF correctly encodes XOR/alternative groups."""
+        uvl_content = '''namespace Test
+
+features
+    Root
+        alternative
+            ChildA
+            ChildB
+'''
+        with tempfile.NamedTemporaryFile(mode='w', suffix='.uvl', delete=False) as f:
+            f.write(uvl_content)
+            temp_file = f.name
+
+        try:
+            model = UVL(from_file=temp_file)
+            cnf = model.to_cnf()
+            
+            assert [1] in cnf.clauses
+            assert [-1, 2, 3] in cnf.clauses
+            assert [-2, -3] in cnf.clauses
+        finally:
+            os.unlink(temp_file)
+
+    def test_cnf_or_constraint(self):
+        """Test that CNF correctly encodes OR groups."""
+        uvl_content = '''namespace Test
+
+features
+    Root
+        or
+            ChildA
+            ChildB
+'''
+        with tempfile.NamedTemporaryFile(mode='w', suffix='.uvl', delete=False) as f:
+            f.write(uvl_content)
+            temp_file = f.name
+
+        try:
+            model = UVL(from_file=temp_file)
+            cnf = model.to_cnf()
+            
+            assert [1] in cnf.clauses
+            assert [-1, 2, 3] in cnf.clauses
+            assert [-2, -3] not in cnf.clauses
+        finally:
+            os.unlink(temp_file)

uvllang-0.1.0/uvllang/__init__.py

@@ -0,0 +1 @@
+from .main import UVL