ui: remove 'compile_builtins'; preserve previous behaviour using 'add…

…_vhdl_builtins' (VUnit#559)
dbhi · Oct 22, 2021 · 2e43c13 · 2e43c13
1 parent 57ccace
commit 2e43c13
Show file tree

Hide file tree

Showing 30 changed files with 53 additions and 17 deletions.
diff --git a/examples/vhdl/array/run.py b/examples/vhdl/array/run.py
@@ -19,6 +19,7 @@
 from vunit import VUnit
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
 VU.add_osvvm()
 
 SRC_PATH = Path(__file__).parent / "src"

diff --git a/examples/vhdl/array_axis_vcs/run.py b/examples/vhdl/array_axis_vcs/run.py
@@ -22,6 +22,7 @@
 from vunit import VUnit
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
 VU.add_verification_components()
 
 SRC_PATH = Path(__file__).parent / "src"

diff --git a/examples/vhdl/axi_dma/run.py b/examples/vhdl/axi_dma/run.py
@@ -21,6 +21,7 @@
 from vunit import VUnit
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
 VU.add_osvvm()
 VU.add_verification_components()
 

diff --git a/examples/vhdl/check/run.py b/examples/vhdl/check/run.py
@@ -17,6 +17,7 @@
 from vunit import VUnit
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
 
 # Enable location preprocessing but exclude all but check_false to make the example less bloated
 VU.enable_location_preprocessing(

diff --git a/examples/vhdl/com/run.py b/examples/vhdl/com/run.py
@@ -19,6 +19,7 @@
 from vunit import VUnit
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
 VU.add_com()
 VU.add_verification_components()
 VU.add_osvvm()

diff --git a/examples/vhdl/composite_generics/run.py b/examples/vhdl/composite_generics/run.py
@@ -22,6 +22,7 @@ def encode(tb_cfg):
 
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
 
 TB_LIB = VU.add_library("tb_lib")
 TB_LIB.add_source_files(Path(__file__).parent / "test" / "*.vhd")

diff --git a/examples/vhdl/coverage/run.py b/examples/vhdl/coverage/run.py
@@ -18,6 +18,7 @@ def post_run(results):
 
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
 
 LIB = VU.add_library("lib")
 LIB.add_source_files(Path(__file__).parent / "*.vhd")

diff --git a/examples/vhdl/generate_tests/run.py b/examples/vhdl/generate_tests/run.py
@@ -63,6 +63,8 @@ def generate_tests(obj, signs, data_widths):
 
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
+
 LIB = VU.add_library("lib")
 LIB.add_source_files(Path(__file__).parent / "test" / "*.vhd")
 

diff --git a/examples/vhdl/json4vhdl/run.py b/examples/vhdl/json4vhdl/run.py
@@ -22,6 +22,7 @@
 TEST_PATH = Path(__file__).parent / "src" / "test"
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
 VU.add_json4vhdl()
 
 LIB = VU.add_library("test")

diff --git a/examples/vhdl/logging/run.py b/examples/vhdl/logging/run.py
@@ -17,6 +17,8 @@
 from vunit import VUnit
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
+
 VU.add_library("lib").add_source_files(Path(__file__).parent / "*.vhd")
 
 VU.main()
diff --git a/examples/vhdl/run/run.py b/examples/vhdl/run/run.py
@@ -19,6 +19,7 @@
 ROOT = Path(__file__).parent
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
 
 LIB = VU.add_library("lib")
 LIB.add_source_files(ROOT / "*.vhd")

diff --git a/examples/vhdl/third_party_integration/run.py b/examples/vhdl/third_party_integration/run.py
@@ -10,5 +10,8 @@
 from vunit import VUnit
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
+
 VU.add_library("lib").add_source_files(Path(__file__).parent / "test" / "*.vhd")
+
 VU.main()
diff --git a/examples/vhdl/uart/run.py b/examples/vhdl/uart/run.py
@@ -18,6 +18,7 @@
 from vunit import VUnit
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
 VU.add_osvvm()
 VU.add_verification_components()
 

diff --git a/examples/vhdl/user_guide/run.py b/examples/vhdl/user_guide/run.py
@@ -18,5 +18,8 @@
 from vunit import VUnit
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
+
 VU.add_library("lib").add_source_files(Path(__file__).parent / "*.vhd")
+
 VU.main()
diff --git a/examples/vhdl/user_guide/vhdl1993/run.py b/examples/vhdl/user_guide/vhdl1993/run.py
@@ -18,5 +18,8 @@
 from vunit import VUnit
 
 VU = VUnit.from_argv(vhdl_standard="93")
+VU.add_vhdl_builtins()
+
 VU.add_library("lib").add_source_files(Path(__file__).parent / "*.vhd")
+
 VU.main()
diff --git a/examples/vhdl/vivado/run.py b/examples/vhdl/vivado/run.py
@@ -20,6 +20,7 @@
 SRC_PATH = ROOT / "src"
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
 
 VU.add_library("lib").add_source_files(SRC_PATH / "*.vhd")
 VU.add_library("tb_lib").add_source_files(SRC_PATH / "test" / "*.vhd")

diff --git a/tests/acceptance/artificial/vhdl/run.py b/tests/acceptance/artificial/vhdl/run.py
@@ -10,6 +10,8 @@
 ROOT = Path(__file__).parent
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
+
 LIB = VU.add_library("lib")
 LIB.add_source_files(ROOT / "*.vhd")
 

diff --git a/tests/acceptance/test_dependencies.py b/tests/acceptance/test_dependencies.py
@@ -49,6 +49,7 @@ def run(value):
                 argv.append("--clean")
 
             ui = VUnit.from_argv(argv=argv)
+            ui.add_vhdl_builtins()
             lib = ui.add_library("lib")
             lib.add_source_files(tb_pkg_file_name)
             lib.add_source_files(pkg_file_name)

diff --git a/tests/unit/test_ui.py b/tests/unit/test_ui.py
@@ -1155,7 +1155,6 @@ def _create_ui_real_sim(self, *args):
         """Create an instance of the VUnit public interface class"""
         return VUnit.from_argv(
             argv=["--output-path=%s" % self._output_path, "--clean"] + list(args),
-            compile_builtins=False,
         )
 
     def _run_main(self, ui, code=0, post_run=None):

diff --git a/vunit/ui/__init__.py b/vunit/ui/__init__.py
@@ -60,14 +60,12 @@ class VUnit(object):  # pylint: disable=too-many-instance-attributes, too-many-p
     def from_argv(
         cls,
         argv=None,
-        compile_builtins: Optional[bool] = True,
         vhdl_standard: Optional[str] = None,
     ):
         """
         Create VUnit instance from command line arguments.
 
         :param argv: Use explicit argv instead of actual command line argument
-        :param compile_builtins: Do not compile builtins. Used for VUnit internal testing.
         :param vhdl_standard: The VHDL standard used to compile files,
                               if None the VUNIT_VHDL_STANDARD environment variable is used
         :returns: A :class:`.VUnit` object instance
@@ -81,13 +79,12 @@ def from_argv(
 
         """
         args = VUnitCLI().parse_args(argv=argv)
-        return cls.from_args(args, compile_builtins=compile_builtins, vhdl_standard=vhdl_standard)
+        return cls.from_args(args, vhdl_standard=vhdl_standard)
 
     @classmethod
     def from_args(
         cls,
         args,
-        compile_builtins: Optional[bool] = True,
         vhdl_standard: Optional[str] = None,
     ):
         """
@@ -97,18 +94,16 @@ def from_args(
         adding custom command line options.
 
         :param args: The parsed argument namespace object
-        :param compile_builtins: Do not compile builtins. Used for VUnit internal testing.
         :param vhdl_standard: The VHDL standard used to compile files,
                               if None the VUNIT_VHDL_STANDARD environment variable is used
         :returns: A :class:`.VUnit` object instance
 
         """
-        return cls(args, compile_builtins=compile_builtins, vhdl_standard=vhdl_standard)
+        return cls(args, vhdl_standard=vhdl_standard)
 
     def __init__(
         self,
         args,
-        compile_builtins: Optional[bool] = True,
         vhdl_standard: Optional[str] = None,
     ):
         self._args = args
@@ -158,15 +153,12 @@ def test_filter(name, attribute_names):
         self._test_bench_list = TestBenchList(database=database)
 
         self._builtins = Builtins(self, self._vhdl_standard, simulator_class)
-        if compile_builtins:
-            self.add_vhdl_builtins()
-            builtins_deprecation_note = (
-                "'compile_builtins' (which defaults to 'True') is deprecated "
-                "and it will be removed in future releases; "
-                "preserve the functionality using "
-                "'compile_builtins=False' and 'VU.add_vhdl_builtins'"
-            )
-            warn(builtins_deprecation_note, Warning)
+
+        builtins_deprecation_note = (
+            "'compile_builtins' ('True' by default) was removed; "
+            "preserve the functionality using 'VU.add_vhdl_builtins'"
+        )
+        warn(builtins_deprecation_note, Warning)
 
     def _create_database(self):
         """

diff --git a/vunit/vhdl/check/run.py b/vunit/vhdl/check/run.py
@@ -16,6 +16,7 @@
 generate_check_match.main()
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
 
 LIB = VU.add_library("lib")
 LIB.add_source_files(Path(ROOT) / "vunit" / "vhdl" / "check" / "test" / "test_support.vhd")

diff --git a/vunit/vhdl/com/run.py b/vunit/vhdl/com/run.py
@@ -10,7 +10,9 @@
 ROOT = Path(__file__).parent
 
 UI = VUnit.from_argv()
+UI.add_vhdl_builtins()
 UI.add_com()
+
 TB_COM_LIB = UI.add_library("tb_com_lib")
 TB_COM_LIB.add_source_files(ROOT / "test" / "*.vhd")
 TB_COM_LIB.package("custom_types_pkg").generate_codecs(

diff --git a/vunit/vhdl/data_types/run.py b/vunit/vhdl/data_types/run.py
@@ -11,6 +11,8 @@
 ROOT = Path(__file__).parent
 
 VU = VUnit.from_argv()
+VU.add_vhdl_builtins()
+
 LIB = VU.library("vunit_lib")
 for fname in glob(str(ROOT / "test" / "*.vhd")):
     if Path(fname).name.endswith("2008p.vhd") and VU.vhdl_standard not in [

diff --git a/vunit/vhdl/dictionary/run.py b/vunit/vhdl/dictionary/run.py
@@ -10,6 +10,8 @@
 ROOT = Path(__file__).parent
 
 UI = VUnit.from_argv()
+UI.add_vhdl_builtins()
+
 UI.add_library("lib").add_source_files(ROOT / "test" / "*.vhd")
 
 UI.main()
diff --git a/vunit/vhdl/logging/run.py b/vunit/vhdl/logging/run.py
@@ -15,6 +15,7 @@ def main():
     root = Path(__file__).parent
 
     ui = VUnit.from_argv()
+    ui.add_vhdl_builtins()
 
     vunit_lib = ui.library("vunit_lib")
     files = glob.glob(str(root / "test" / "*.vhd"))

diff --git a/vunit/vhdl/path/run.py b/vunit/vhdl/path/run.py
@@ -10,6 +10,8 @@
 ROOT = Path(__file__).parent
 
 UI = VUnit.from_argv()
+UI.add_vhdl_builtins()
+
 UI.add_library("lib").add_source_files(ROOT / "test" / "*.vhd")
 
 UI.main()
diff --git a/vunit/vhdl/random/run.py b/vunit/vhdl/random/run.py
@@ -10,7 +10,9 @@
 ROOT = Path(__file__).parent
 
 UI = VUnit.from_argv()
+UI.add_vhdl_builtins()
 UI.add_random()
+
 UI.library("vunit_lib").add_source_files(ROOT / "test" / "*.vhd")
 
 UI.main()
diff --git a/vunit/vhdl/run/run.py b/vunit/vhdl/run/run.py
@@ -10,6 +10,8 @@
 ROOT = Path(__file__).parent
 
 UI = VUnit.from_argv()
+UI.add_vhdl_builtins()
+
 UI.add_library("tb_run_lib").add_source_files(ROOT / "test" / "*.vhd")
 
 UI.main()
diff --git a/vunit/vhdl/string_ops/run.py b/vunit/vhdl/string_ops/run.py
@@ -10,6 +10,8 @@
 ROOT = Path(__file__).parent
 
 UI = VUnit.from_argv()
+UI.add_vhdl_builtins()
+
 UI.add_library("lib").add_source_files(ROOT / "test" / "*.vhd")
 
 UI.main()
diff --git a/vunit/vhdl/verification_components/run.py b/vunit/vhdl/verification_components/run.py
@@ -11,8 +11,10 @@
 ROOT = Path(__file__).parent
 
 UI = VUnit.from_argv()
+UI.add_vhdl_builtins()
 UI.add_random()
 UI.add_verification_components()
+
 LIB = UI.library("vunit_lib")
 LIB.add_source_files(ROOT / "test" / "*.vhd")