🚧 ensure a valid python identifier for report_manger.py streamlit file (#105)

* 🚧 ensure a valid python identifier for report_manger.py streamlit file

save subsection are also referenced as Page instances, therefore they need a valid Python variable name.

This would not be catched at build time, but only when report is being run.

* 🚚 move utils to subpackage - helps to split up utils into submodules

* ✨ add test for valid identifier fct. move to utils

* 🐛 add missing import

Author: enryH

src/vuegen/streamlit_reportview.py

@@ -1,4 +1,5 @@
 import os
+import re
 import subprocess
 import sys
 from pathlib import Path
@@ -9,6 +10,7 @@
 
 from . import report as r
 from .utils import create_folder, generate_footer, is_url
+from .utils.variables import make_valid_identifier
 
 
 class StreamlitReportView(r.WebAppReportView):
@@ -114,7 +116,15 @@ def generate_report(
                     )
 
                 for subsection in section.subsections:
-                    subsection_name_var = subsection.title.replace(" ", "_")
+                    # ! could add a non-integer to ensure it's a valid identifier
+                    subsection_name_var = make_valid_identifier(subsection.title)
+                    if not subsection_name_var.isidentifier():
+                        self.report.logger.warning(
+                            f"Subsection name '{subsection_name_var}' is not a valid identifier."
+                        )
+                        raise ValueError(
+                            f"Subsection name is not a valid Python identifier: {subsection_name_var}"
+                        )
                     subsection_file_path = (
                         Path(section_name_var) / f"{subsection_name_var}.py"
                     ).as_posix()  # Make sure it's Posix Paths
@@ -336,10 +346,11 @@ def _generate_sections(self, output_dir: str, static_dir: str) -> None:
                         )
                         try:
                             # Create subsection file
+                            _subsection_name = make_valid_identifier(subsection.title)
                             subsection_file_path = (
                                 Path(output_dir)
                                 / section_name_var
-                                / f"{subsection.title.replace(' ', '_')}.py"
+                                / f"{_subsection_name}.py"
                             )
 
                             # Generate content and imports for the subsection

src/vuegen/utils.py renamed to src/vuegen/utils/__init__.py

@@ -0,0 +1,12 @@
+import re
+
+
+def make_valid_identifier(name: str) -> str:
+    """Create a valid Python identifier from a given name.
+
+    Used in streamlit report sections to build structure (pages).
+    """
+    ret = re.sub(r"[^a-zA-Z0-9]", "_", name)
+    if not ret[0].isalpha():
+        ret = "_" + ret
+    return ret

src/vuegen/utils/variables.py

@@ -0,0 +1,16 @@
+import pytest
+
+from vuegen.utils.variables import make_valid_identifier
+
+test_cases = [
+    ("a.non valid name", "a_non_valid_name"),
+    ("1.non valid name", "_1_non_valid_name"),
+    ("a_valid_name", "a_valid_name"),
+    ("test", "test"),
+]
+
+
+@pytest.mark.parametrize("var_name,expected", test_cases)
+def test_make_valid_identifier(var_name, expected):
+    """Test the make_valid_identifier function."""
+    assert make_valid_identifier(var_name) == expected