🎨 pass relative section file paths on using Section dataclasses

- Section could be used everywhere, Subsection is not really necessary. If a Section has subsections, the logic changes. Else nothing changes.

Author: enryH

src/vuegen/report.py

@@ -678,13 +678,17 @@ class Subsection:
         A list of components within the subsection.
     description : str, optional
         A description of the subsection (default is None).
+    file_path : str, optional
+        Relative file path to the section file in sections folder.
+        Used for building reports (default is None).
     """
 
     _id_counter: ClassVar[int] = 0
     id: int = field(init=False)
     title: str
     components: List["Component"] = field(default_factory=list)
     description: Optional[str] = None
+    file_path: Optional[str] = None
 
     def __post_init__(self):
         self.id = self._generate_id()
@@ -695,6 +699,7 @@ def _generate_id(cls) -> int:
         return cls._id_counter
 
 
+# ? Section is a subclass of Subsection (adding subsections). Destinction might not be necessary
 @dataclass
 class Section:
     """
@@ -710,8 +715,13 @@ class Section:
         Title of the section.
     subsections : List[Subsection]
         A list of subsections within the section.
+    components : List[Component]
+        A list of components within the subsection.
     description : str, optional
         A description of the section (default is None).
+    file_path : str, optional
+        Relative file path to the section file in sections folder.
+        Used for building reports (default is None).
     """
 
     _id_counter: ClassVar[int] = 0
@@ -720,6 +730,7 @@ class Section:
     subsections: List["Subsection"] = field(default_factory=list)
     components: List["Component"] = field(default_factory=list)
     description: Optional[str] = None
+    file_path: Optional[str] = None
 
     def __post_init__(self):
         self.id = self._generate_id()

src/vuegen/streamlit_reportview.py

@@ -136,7 +136,9 @@ def generate_report(self, output_dir: str = SECTIONS_DIR) -> None:
             for section in self.report.sections[1:]:  # skip home section components
                 # Create a folder for each section
                 subsection_page_vars = []
-                section_name_var = section.title.replace(" ", "_")
+                section_name_var = make_valid_identifier(
+                    section.title.replace(" ", "_")
+                )
                 section_dir_path = Path(output_dir) / section_name_var
 
                 if create_folder(section_dir_path):
@@ -151,9 +153,9 @@ def generate_report(self, output_dir: str = SECTIONS_DIR) -> None:
                 if section.components:
                     subsection_file_path = (
                         Path(section_name_var)
-                        / f"0_overview_{section.title.lower()}.py"
+                        / f"0_overview_{make_valid_identifier(section.title).lower()}.py"
                     ).as_posix()  # Make sure it's Posix Paths
-
+                    section.file_path = subsection_file_path
                     # Create a Page object for each subsection and add it to the home page content
                     report_manag_content.append(
                         f"{section_name_var}_overview = st.Page('{subsection_file_path}', title='Overview {section.title}')"
@@ -173,7 +175,7 @@ def generate_report(self, output_dir: str = SECTIONS_DIR) -> None:
                     subsection_file_path = (
                         Path(section_name_var) / f"{subsection_name_var}.py"
                     ).as_posix()  # Make sure it's Posix Paths
-
+                    subsection.file_path = subsection_file_path
                     # Create a Page object for each subsection and add it to the home page content
                     report_manag_content.append(
                         f"{subsection_name_var} = st.Page('{subsection_file_path}', title='{subsection.title}')"
@@ -402,16 +404,11 @@ def _generate_sections(self, output_dir: str) -> None:
                     section_content, section_imports, _ = self._combine_components(
                         section.components
                     )
-                    _filepath_overview = (
-                        Path(output_dir)
-                        / section_name_var
-                        / f"0_overview_{section.title.lower()}.py"
-                        # ! tighly coupled to generate_report fct:
-                        # ! check how to pass file names
-                    )
-
+                    assert (
+                        section.file_path is not None
+                    ), "Missing relative file path to overview page in section"
                     write_python_file(
-                        fpath=_filepath_overview,
+                        fpath=Path(output_dir) / section.file_path,
                         imports=section_imports,
                         contents=section_content,
                     )
@@ -433,12 +430,10 @@ def _generate_sections(self, output_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_name}.py"
-                        )
-
+                        assert (
+                            subsection.file_path is not None
+                        ), "Missing relative file path to subsection"
+                        subsection_file_path = Path(output_dir) / subsection.file_path
                         # Generate content and imports for the subsection
                         subsection_content, subsection_imports = (
                             self._generate_subsection(subsection)