labview-fpga-hdl-tools 2.0.0.dev2__tar.gz → 2.0.0.dev4__tar.gz

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev4}/PKG-INFO

@@ -1,19 +1,19 @@
 Metadata-Version: 2.3
 Name: labview-fpga-hdl-tools
-Version: 2.0.0.dev2
+Version: 2.0.0.dev4
 Summary: LabVIEW FPGA HDL Tools
 License: MIT
 Author: Salvador Santolucito
 Author-email: salvador.santolucito@gmail.com
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.10,<3.15
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: click (>=8.1.8,<8.2)
+Requires-Dist: defusedxml (>=0.7.1)
 Requires-Dist: mako (>=1.3.10)
 Requires-Dist: packaging (>=21.0)
 Requires-Dist: tomli (>=1.1.0) ; python_version < "3.11"
@@ -66,8 +66,8 @@ You need the external tools your flow uses:
 - **ModelSim** — only for simulation (`gen-modelsim`, `sim-modelsim`,
   `launch-modelsim`, `compile-modelsim-lib`). `compile-modelsim-lib` also needs
   Vivado to compile the Xilinx simulation libraries.
-- **Git** and **Python** — the tools support Python 3.9+; CI tests on 3.9 and
-  3.11 (3.11 is also used for static analysis).
+- **Git** and **Python** — the tools support Python 3.10–3.14; CI tests on
+  3.10 through 3.14 (3.11 is also used for static analysis).
 
 ### Installing the tools
 

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev4}/README.md

@@ -45,8 +45,8 @@ You need the external tools your flow uses:
 - **ModelSim** — only for simulation (`gen-modelsim`, `sim-modelsim`,
   `launch-modelsim`, `compile-modelsim-lib`). `compile-modelsim-lib` also needs
   Vivado to compile the Xilinx simulation libraries.
-- **Git** and **Python** — the tools support Python 3.9+; CI tests on 3.9 and
-  3.11 (3.11 is also used for static analysis).
+- **Git** and **Python** — the tools support Python 3.10–3.14; CI tests on
+  3.10 through 3.14 (3.11 is also used for static analysis).
 
 ### Installing the tools
 

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev4}/labview_fpga_hdl_tools/__main__.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 """LVFPGAHDLTools - Command-line interface for LabVIEW FPGA HDL Tools."""
+
 # Copyright (c) 2025 National Instruments Corporation
 #
 # SPDX-License-Identifier: MIT
@@ -11,7 +12,7 @@ import traceback
 import click
 
 # Import main functions from all the tool modules
-from . import (
+from labview_fpga_hdl_tools import (
     __version__,
     check_syntax,
     command_hooks,
@@ -32,7 +33,7 @@ from . import (
     process_constraints,
     sim_modelsim,
 )
-from .reporting import reporter
+from labview_fpga_hdl_tools.reporting import reporter
 
 
 class SectionGroup(click.Group):

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev4}/labview_fpga_hdl_tools/check_syntax.py

@@ -8,8 +8,9 @@
 import os
 import subprocess
 
-from . import common
-from .reporting import reporter
+from labview_fpga_hdl_tools import common
+from labview_fpga_hdl_tools.command_config import CommandConfiguration
+from labview_fpga_hdl_tools.reporting import reporter
 
 
 def _generate_check_syntax_tcl(config, output_path):
@@ -83,12 +84,9 @@ def _validate_ini(config):
             if invalid_path:
                 invalid_paths.append(invalid_path)
 
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-
-    if missing_settings or invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def _get_check_syntax_status_from_log(log_contents):
@@ -109,16 +107,7 @@ def _get_check_syntax_status_from_log(log_contents):
 
 def _run_check_syntax(config, generated_tcl_path):
     """Run the generated check-syntax TCL script in Vivado batch mode."""
-    vivado_executable = common.get_vivado_executable(config.vivado_tools_folder)
-    if not vivado_executable:
-        raise ValueError("VivadoToolsFolder setting is missing from configuration")
-
-    vivado_abs = os.path.abspath(vivado_executable)
-    if not os.path.exists(vivado_abs):
-        raise FileNotFoundError(
-            f"Vivado executable not found at: {vivado_abs}\n"
-            f"Please check your --vivado argument or VivadoToolsFolder setting in nihdlsettings.py"
-        )
+    vivado_abs = common.resolve_vivado_executable_abs(config)
 
     vivado_project_dir = os.path.join(os.getcwd(), config.vivado_project_folder)
     log_path = os.path.join(vivado_project_dir, "check_syntax.log")
@@ -128,19 +117,24 @@ def _run_check_syntax(config, generated_tcl_path):
         if os.path.exists(path):
             os.remove(path)
 
-    command = (
-        f'"{vivado_abs}" -mode batch '
-        f'-source "{generated_tcl_path}" '
-        f'-log "{log_path}" '
-        f'-journal "{journal_path}"'
-    )
+    command = [
+        vivado_abs,
+        "-mode",
+        "batch",
+        "-source",
+        generated_tcl_path,
+        "-log",
+        log_path,
+        "-journal",
+        journal_path,
+    ]
 
     reporter.detail(f"Generated TCL script: {generated_tcl_path}")
     reporter.detail(f"Vivado executable: {vivado_abs}")
     reporter.detail(f"Working directory: {vivado_project_dir}")
-    reporter.detail(f"Running command: {command}")
+    reporter.detail(f"Running command: {' '.join(command)}")
 
-    result = subprocess.run(command, cwd=vivado_project_dir, shell=True, check=False)
+    result = subprocess.run(command, cwd=vivado_project_dir, check=False)
 
     if not os.path.exists(log_path):
         raise RuntimeError("Vivado check-syntax log file was not created.")
@@ -185,7 +179,7 @@ def check_syntax(config=None):
         int: 0 for success, 1 for error
     """
     if config is None:
-        config = common.CommandConfiguration()
+        config = CommandConfiguration()
 
     try:
         _validate_ini(config)

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev4}/labview_fpga_hdl_tools/common.py

@@ -14,8 +14,7 @@ from typing import Optional
 
 from mako.template import Template
 
-from .command_config import CommandConfiguration, resolve_path  # noqa: F401
-from .reporting import reporter
+from labview_fpga_hdl_tools.reporting import reporter
 
 
 def handle_long_path(path):
@@ -237,7 +236,8 @@ def _parse_vhdl_entity(vhdl_path):
 
     except Exception as e:
         reporter.error(f"Error parsing VHDL file: {str(e)}")
-        traceback.print_exc()
+        if reporter.verbose:
+            traceback.print_exc()
         return None, []
 
 
@@ -406,10 +406,16 @@ def apply_hdl_excludes(file_list, excluded_abspaths):
 
 
 def run_command(cmd, cwd=None, capture_output=True, check=False):
-    """Run a shell command and return its output.
+    """Run a command and return its output.
+
+    The command is given as a pre-tokenized argument list (for example
+    ``[vivado_abs, "-mode", "batch", ...]``) and is executed directly without a
+    shell. Passing an argument list means arguments containing spaces or
+    shell-significant characters are passed through verbatim (no quoting bugs)
+    and there is no shell-injection surface.
 
     Args:
-        cmd: Command string to run through the shell.
+        cmd: The command to run, as a list of arguments.
         cwd: Working directory to run the command in, if any.
         capture_output: When True, capture stdout and return it as a string.
             When False, let the command's output stream to the console and
@@ -421,7 +427,7 @@ def run_command(cmd, cwd=None, capture_output=True, check=False):
         The captured stdout (stripped) when ``capture_output`` is True, otherwise
         an empty string.
     """
-    reporter.detail(f"Running command: {cmd}")
+    reporter.detail(f"Running command: {' '.join(str(arg) for arg in cmd)}")
 
     kwargs = {}
     if cwd:
@@ -429,14 +435,12 @@ def run_command(cmd, cwd=None, capture_output=True, check=False):
 
     if capture_output:
         # Capture and return output
-        result = subprocess.run(
-            cmd, shell=True, text=True, capture_output=True, check=check, **kwargs
-        )
+        result = subprocess.run(cmd, text=True, capture_output=True, check=check, **kwargs)
         # Check if stdout is None before calling strip()
         return result.stdout.strip() if result.stdout is not None else ""
     else:
         # Don't capture output (let it go to console)
-        subprocess.run(cmd, shell=True, check=check, **kwargs)
+        subprocess.run(cmd, check=check, **kwargs)
         return ""  # Return empty string instead of None
 
 
@@ -495,6 +499,48 @@ def get_invalid_paths_error(invalid_paths):
     return error_msg
 
 
+def build_settings_error(missing_settings, invalid_paths):
+    """Return the standard missing-settings / invalid-paths message, or "" if none.
+
+    Combines the missing-settings and invalid-path messages with the shared hint
+    used by every ``_validate_ini``. Returns an empty string when there is
+    nothing to report, so callers can do ``if error: raise ValueError(error)``
+    (or report-and-return) without repeating the concatenation and hint text.
+    """
+    if not (missing_settings or invalid_paths):
+        return ""
+    return (
+        get_missing_settings_error(missing_settings)
+        + get_invalid_paths_error(invalid_paths)
+        + "\nPlease update your configuration file and try again."
+    )
+
+
+def resolve_vivado_executable_abs(config):
+    """Resolve the Vivado executable to an absolute path.
+
+    Args:
+        config: CommandConfiguration providing ``vivado_tools_folder``.
+
+    Returns:
+        str: Absolute path to the Vivado executable.
+
+    Raises:
+        ValueError: if the executable cannot be resolved from the configuration.
+        FileNotFoundError: if the resolved executable does not exist on disk.
+    """
+    vivado_executable = get_vivado_executable(config.vivado_tools_folder)
+    if not vivado_executable:
+        raise ValueError("VivadoToolsFolder setting is missing from configuration")
+    vivado_abs = os.path.abspath(vivado_executable)
+    if not os.path.exists(vivado_abs):
+        raise FileNotFoundError(
+            f"Vivado executable not found at: {vivado_abs}\n"
+            "Please check your VivadoToolsFolder setting in nihdlsettings.py"
+        )
+    return vivado_abs
+
+
 def collect_missing_settings(config, required):
     """Return the labels of required settings that are unset (falsy) on config.
 
@@ -517,23 +563,21 @@ def collect_missing_settings(config, required):
 def raise_for_missing_settings(missing_settings, invalid_paths):
     """Raise ``ValueError`` for missing settings or invalid paths, if any.
 
-    Missing settings take precedence over invalid paths. Produces the standard
-    launch-style messages shared by the launch commands. Does nothing when both
-    lists are empty.
+    Missing settings take precedence over invalid paths (only one message is
+    raised). Uses the shared ``get_missing_settings_error`` /
+    ``get_invalid_paths_error`` builders so the wording matches the
+    ``_validate_ini`` validators. Does nothing when both lists are empty.
     """
     if missing_settings:
-        error_msg = "Missing required configuration settings:\n"
-        for setting in missing_settings:
-            error_msg += f"  - {setting}\n"
-        error_msg += "\nCheck your nihdlsettings.py file and try again."
-        raise ValueError(error_msg)
-
+        raise ValueError(
+            get_missing_settings_error(missing_settings)
+            + "\nPlease update your configuration file and try again."
+        )
     if invalid_paths:
-        error_msg = "The following settings have invalid paths:\n"
-        for path in invalid_paths:
-            error_msg += f"  - {path}\n"
-        error_msg += "\nCheck your configuration and try again."
-        raise ValueError(error_msg)
+        raise ValueError(
+            get_invalid_paths_error(invalid_paths)
+            + "\nPlease update your configuration file and try again."
+        )
 
 
 def generate_guid():
@@ -554,7 +598,7 @@ def render_mako_template(template_path, output_path, **kwargs):
         output_path (str): Path where the rendered output will be written
         **kwargs: Template variables to substitute
     """
-    template = Template(filename=template_path, input_encoding="utf-8")
+    template = Template(filename=template_path, input_encoding="utf-8")  # nosec B702
     rendered = str(template.render(**kwargs))
 
     # Mako preserves \r\n from template files on Windows. Normalize to \n

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev4}/labview_fpga_hdl_tools/compile_modelsim_lib.py

@@ -21,9 +21,10 @@ import os
 import subprocess
 import sys
 
-from . import common
-from .create_modelsim_project import _find_modelsim_executable
-from .reporting import reporter
+from labview_fpga_hdl_tools import common
+from labview_fpga_hdl_tools.command_config import CommandConfiguration
+from labview_fpga_hdl_tools.create_modelsim_project import _find_modelsim_executable
+from labview_fpga_hdl_tools.reporting import reporter
 
 # Libraries built when nihdlsettings.py does not specify an explicit scope.
 _DEFAULT_XILINX_SIM_LIBRARIES = ["unisim", "secureip"]
@@ -69,11 +70,9 @@ def _validate_ini(config):
                 f"{config.modelsim_tools_folder}"
             )
 
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-    if missing_settings or invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def _libraries_already_built(out_folder, libraries):
@@ -134,16 +133,7 @@ def _is_progress_line(line):
 
 def _run_compile_simlib(config, tcl_path, out_folder, libraries):
     """Run the generated compile_simlib TCL script in Vivado batch mode."""
-    vivado_executable = common.get_vivado_executable(config.vivado_tools_folder)
-    if not vivado_executable:
-        raise ValueError("VivadoToolsFolder setting is missing from configuration")
-
-    vivado_abs = os.path.abspath(vivado_executable)
-    if not os.path.exists(vivado_abs):
-        raise FileNotFoundError(
-            f"Vivado executable not found at: {vivado_abs}\n"
-            f"Please check your VivadoToolsFolder setting in nihdlsettings.py"
-        )
+    vivado_abs = common.resolve_vivado_executable_abs(config)
 
     os.makedirs(out_folder, exist_ok=True)
     # Use a distinct name for Vivado's session log/journal. compile_simlib
@@ -165,12 +155,19 @@ def _run_compile_simlib(config, tcl_path, out_folder, libraries):
                     "try again."
                 ) from exc
 
-    command = (
-        f'"{vivado_abs}" -mode batch '
-        f'-source "{tcl_path}" '
-        f'-log "{log_path}" '
-        f'-journal "{journal_path}"'
-    )
+    # Build the argument list explicitly and run without a shell so paths that
+    # contain spaces or shell-significant characters are passed through verbatim.
+    command = [
+        vivado_abs,
+        "-mode",
+        "batch",
+        "-source",
+        tcl_path,
+        "-log",
+        log_path,
+        "-journal",
+        journal_path,
+    ]
 
     # Run with the MODELSIM environment variable unset so compile_simlib does
     # not read or modify a global modelsim.ini; it writes a fresh one into the
@@ -181,7 +178,7 @@ def _run_compile_simlib(config, tcl_path, out_folder, libraries):
     reporter.detail(f"Vivado executable: {vivado_abs}")
     reporter.detail(f"Output directory:  {out_folder}")
     reporter.detail(f"Libraries:         {', '.join(libraries)}")
-    reporter.detail(f"Running command:   {command}")
+    reporter.detail(f"Running command:   {' '.join(command)}")
     reporter.success("")
     reporter.success("=" * 78)
     reporter.success("Compiling the Xilinx ModelSim simulation libraries with Vivado.")
@@ -201,7 +198,7 @@ def _run_compile_simlib(config, tcl_path, out_folder, libraries):
     process = subprocess.Popen(
         command,
         cwd=out_folder,
-        shell=True,
+        shell=False,
         env=env,
         stdout=subprocess.PIPE,
         stderr=subprocess.STDOUT,
@@ -254,7 +251,7 @@ def compile_modelsim_lib(config=None, force=False):
         int: 0 for success, 1 for error.
     """
     if config is None:
-        config = common.CommandConfiguration()
+        config = CommandConfiguration()
 
     out_folder = config.xilinx_sim_lib_folder
     if not out_folder:

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev4}/labview_fpga_hdl_tools/compile_project.py

@@ -8,8 +8,9 @@
 import os
 import subprocess
 
-from . import common
-from .reporting import reporter
+from labview_fpga_hdl_tools import common
+from labview_fpga_hdl_tools.command_config import CommandConfiguration
+from labview_fpga_hdl_tools.reporting import reporter
 
 
 def _generate_compile_project_tcl(config, output_path):
@@ -25,12 +26,12 @@ def _generate_compile_project_tcl(config, output_path):
 
 def _validate_ini(config):
     """Validate required settings and paths for compile-project."""
-    missing_settings = []
+    missing_settings = common.collect_missing_settings(
+        config,
+        [("vivado_project_folder", "VivadoProjectSettings.VivadoProjectFolder")],
+    )
     invalid_paths = []
 
-    if not config.vivado_project_folder:
-        missing_settings.append("VivadoProjectSettings.VivadoProjectFolder")
-
     if not config.vivado_tcl_scripts_folder:
         missing_settings.append("VivadoProjectSettings.VivadoTclScriptsFolder")
     else:
@@ -72,12 +73,9 @@ def _validate_ini(config):
             if invalid_path:
                 invalid_paths.append(invalid_path)
 
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-
-    if missing_settings or invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def _get_compile_status_from_log(log_contents):
@@ -103,16 +101,7 @@ def _get_compile_status_from_log(log_contents):
 
 def _run_compile_project(config, generated_tcl_path):
     """Run the generated compile-project TCL script in Vivado batch mode."""
-    vivado_executable = common.get_vivado_executable(config.vivado_tools_folder)
-    if not vivado_executable:
-        raise ValueError("VivadoToolsFolder setting is missing from configuration")
-
-    vivado_abs = os.path.abspath(vivado_executable)
-    if not os.path.exists(vivado_abs):
-        raise FileNotFoundError(
-            f"Vivado executable not found at: {vivado_abs}\n"
-            f"Please check your --vivado argument or VivadoToolsFolder setting in nihdlsettings.py"
-        )
+    vivado_abs = common.resolve_vivado_executable_abs(config)
 
     current_dir = os.getcwd()
     vivado_project_dir = os.path.join(current_dir, config.vivado_project_folder)
@@ -123,18 +112,23 @@ def _run_compile_project(config, generated_tcl_path):
         if os.path.exists(path):
             os.remove(path)
 
-    command = (
-        f'"{vivado_abs}" -mode batch '
-        f'-source "{generated_tcl_path}" '
-        f'-log "{log_path}" '
-        f'-journal "{journal_path}"'
-    )
+    command = [
+        vivado_abs,
+        "-mode",
+        "batch",
+        "-source",
+        generated_tcl_path,
+        "-log",
+        log_path,
+        "-journal",
+        journal_path,
+    ]
 
     reporter.detail(f"Vivado executable: {vivado_abs}")
     reporter.detail(f"Working directory: {vivado_project_dir}")
-    reporter.detail(f"Running command: {command}")
+    reporter.detail(f"Running command: {' '.join(command)}")
 
-    result = subprocess.run(command, cwd=vivado_project_dir, shell=True, check=False)
+    result = subprocess.run(command, cwd=vivado_project_dir, check=False)
 
     if not os.path.exists(log_path):
         raise RuntimeError("Vivado compile-project log file was not created.")
@@ -194,7 +188,7 @@ def compile_project(config=None):
         int: 0 for success, 1 for error
     """
     if config is None:
-        config = common.CommandConfiguration()
+        config = CommandConfiguration()
 
     try:
         _validate_ini(config)

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev4}/labview_fpga_hdl_tools/create_lvbitx.py

@@ -7,8 +7,8 @@
 import os  # For file and directory operations
 import subprocess  # For executing external programs
 
-from . import common  # For shared utilities across tools
-from .reporting import reporter
+from labview_fpga_hdl_tools.command_config import CommandConfiguration
+from labview_fpga_hdl_tools.reporting import reporter
 
 # createBitfile.exe lives at this path relative to a LabVIEW install root.
 _CREATEBITFILE_RELPATH = os.path.join("vi.lib", "rvi", "CDR", "createBitfile.exe")
@@ -114,7 +114,7 @@ def _create_lv_bitfile(config=None):
 
     # Load configuration
     if config is None:
-        config = common.CommandConfiguration()
+        config = CommandConfiguration()
 
     # Determine path to CodeGenerationResults.lvtxt from TheWindow folder
     if not config.lv_window_netlist_folder:
@@ -211,7 +211,8 @@ def create_lv_bitx(config=None):
         return result  # Return the result code
     except Exception as e:
         reporter.error(f"Unhandled exception: {str(e)}")
-        import traceback
+        if reporter.verbose:
+            import traceback
 
-        traceback.print_exc()
+            traceback.print_exc()
         return 1  # Return error code on exception

{labview_fpga_hdl_tools-2.0.0.dev2 → labview_fpga_hdl_tools-2.0.0.dev4}/labview_fpga_hdl_tools/create_modelsim_project.py

@@ -11,8 +11,9 @@ import shutil
 import stat
 import subprocess
 
-from . import common, generate_vhdl
-from .reporting import reporter
+from labview_fpga_hdl_tools import common, generate_vhdl
+from labview_fpga_hdl_tools.command_config import CommandConfiguration
+from labview_fpga_hdl_tools.reporting import reporter
 
 
 def _validate_ini(config):
@@ -61,11 +62,9 @@ def _validate_ini(config):
                     f"{config.modelsim_tools_folder}"
                 )
 
-    error_msg = common.get_missing_settings_error(missing_settings)
-    error_msg += common.get_invalid_paths_error(invalid_paths)
-    if missing_settings or invalid_paths:
-        error_msg += "\nPlease update your configuration file and try again."
-        raise ValueError(error_msg)
+    error = common.build_settings_error(missing_settings, invalid_paths)
+    if error:
+        raise ValueError(error)
 
 
 def _get_vsim_executable(modelsim_path):
@@ -428,7 +427,7 @@ def create_modelsim_project(overwrite=False, config=None):
     - .do files for GUI and batch simulation
     """
     if config is None:
-        config = common.CommandConfiguration()
+        config = CommandConfiguration()
 
     try:
         _validate_ini(config)
@@ -501,7 +500,7 @@ def create_modelsim_project(overwrite=False, config=None):
         # This is idempotent: once compiled it is a cheap no-op (and does not
         # even require Vivado). Imported locally to avoid a circular import,
         # since compile_modelsim_lib imports helpers from this module.
-        from . import compile_modelsim_lib
+        from labview_fpga_hdl_tools import compile_modelsim_lib
 
         if compile_modelsim_lib.compile_modelsim_lib(config=config) != 0:
             return 1