Create BASE_DIR and STATIC_FILES_DIR global variables to define paths and include all static outputs into a specific folder in the streamlit and quart reports

Author: sayalaruano

report/quarto_reportview.py

@@ -16,28 +16,24 @@ class ReportFormat(StrEnum):
 class QuartoReportView(r.ReportView):
     """
     A ReportView subclass for generating Quarto reports.
-
-    Methods
-    -------
-    generate_report(output_dir)
-        Generates the qmd file of the quarto report. It creates code for rendering each section and its subsections with all components.
-    run_report(output_dir)
-        Runs the generated quarto report.
     """
 
-    def __init__(self, identifier: int, name: str, report: r.Report, report_type: r.ReportType, 
+    BASE_DIR = 'quarto_report'
+    STATIC_FILES_DIR = os.path.join(BASE_DIR, 'static')
+
+    def __init__(self, id: int, name: str, report: r.Report, report_type: r.ReportType, 
                 columns: Optional[List[str]], report_format: ReportFormat):
-        super().__init__(identifier, name=name, report=report, report_type = report_type, columns=columns)
+        super().__init__(id, name=name, report=report, report_type = report_type, columns=columns)
         self.report_format = report_format
 
-    def generate_report(self, output_dir: str = 'quarto_report/') -> None:
+    def generate_report(self, output_dir: str = BASE_DIR) -> None:
         """
         Generates the qmd file of the quarto report. It creates code for rendering each section and its subsections with all components.
 
         Parameters
         ----------
         output_dir : str, optional
-            The folder where the generated report files will be saved (default is 'quarto_report/').
+            The folder where the generated report files will be saved (default is BASE_DIR).
         """
         # Create the output folder if it does not exist
         if not os.path.exists(output_dir):
@@ -93,7 +89,7 @@ def generate_report(self, output_dir: str = 'quarto_report/') -> None:
 ```\n\n""")
             quarto_report.write("\n".join(qmd_content))
 
-    def run_report(self, output_dir: str = 'quarto_report') -> None:
+    def run_report(self, output_dir: str = BASE_DIR) -> None:
         """
         Runs the generated quarto report.
 
@@ -216,7 +212,7 @@ def _generate_subsection(self, subsection, is_report_static, is_report_revealjs)
 
         return subsection_content, subsection_imports
 
-    def _generate_plot_content(self, plot, is_report_static) -> List[str]:
+    def _generate_plot_content(self, plot, is_report_static, output_dir: str = STATIC_FILES_DIR) -> List[str]:
         """
         Generate content for a plot component based on the report type.
 
@@ -231,15 +227,23 @@ def _generate_plot_content(self, plot, is_report_static) -> List[str]:
         -------
         list : List[str]
             The list of content lines for the plot.
+        output_dir : str, optional
+            The folder where the static files will be saved (default is STATIC_FILES_DIR).
         """
+        # Create the output folder if it does not exist
+        if not os.path.exists(output_dir):
+            os.mkdir(output_dir)
+
         plot_content = []
         plot_content.append(f'### {plot.title}')
         if plot.plot_type == r.PlotType.INTERACTIVE:
             # Define plot path
             if is_report_static:
-                static_plot_path = f"quarto_report/{plot.name.replace(' ', '_')}.png"
+                #static_plot_path = f"{output_dir}/{plot.name.replace(' ', '_')}.png"
+                static_plot_path  = os.path.join(output_dir, f"{plot.name.replace(' ', '_')}.png")
             else:
-                html_plot_file = f"quarto_report/{plot.name.replace(' ', '_')}.html"
+                #html_plot_file = f"{output_dir}/{plot.name.replace(' ', '_')}.html"
+                html_plot_file  = os.path.join(output_dir, f"{plot.name.replace(' ', '_')}.html")
 
             if plot.int_visualization_tool == r.IntVisualizationTool.PLOTLY:
                 plot_content.append(self._generate_plot_code(plot))
@@ -402,7 +406,7 @@ def _generate_image_content(self, image_path: str, alt_text: str = "", width: in
         return f"""
 ![{alt_text}]({os.path.join('..', image_path)}){{ width={width}px height={height}px fig-align="center"}}\n"""
 
-    def _show_dataframe(self, dataframe, is_report_static) -> List[str]:
+    def _show_dataframe(self, dataframe, is_report_static, output_dir: str = STATIC_FILES_DIR) -> List[str]:
         """
         Appends either a static image or an interactive representation of a DataFrame to the content list.
 
@@ -417,11 +421,14 @@ def _show_dataframe(self, dataframe, is_report_static) -> List[str]:
         -------
         list : List[str]
             The list of content lines for the DataFrame.
+        output_dir : str, optional
+            The folder where the static files will be saved (default is STATIC_FILES_DIR).
         """
         dataframe_content = []
         if is_report_static:
             # Generate path for the DataFrame image
-            df_image = f"quarto_report/{dataframe.name.replace(' ', '_')}.png"
+            #df_image = f"quarto_report/{dataframe.name.replace(' ', '_')}.png"
+            df_image = os.path.join(output_dir, f"{dataframe.name.replace(' ', '_')}.png")
             dataframe_content.append(f"dfi.export(df, '{os.path.join('..', df_image)}', max_rows=10, max_cols=5)\n```\n")
             # Use helper method to add centered image content
             dataframe_content.append(self._generate_image_content(df_image, dataframe.name))

report/streamlit_reportview.py

@@ -6,35 +6,24 @@
 
 class StreamlitReportView(r.WebAppReportView):
     """
-    A Streamlit-based implementation of a report view interface.
-
-    Methods
-    -------
-    generate_report(output_dir)
-        Generates the Streamlit report and saves the report files to the specified folder.
-    run_report(output_dir)
-        Runs the generated Streamlit report.
-    _fornat_text(text, type, level, color)
-        Generates a Streamlit markdown text string with the specified type (header, paragraph), level and color.
-    _generate_home_section(output_dir, report_manag_content)
-        Generates the homepage for the report and updates the report manager content.
-    _generate_sections(output_dir)
-        Generates Python files for each section in the report, including subsections and its components (plots, dataframes, markdown).
-    _generate_subsection(subsection, imports_written, content)
-        Creates components (plots, dataframes, markdown, etc) for a given subsection. 
+    A Streamlit-based implementation of the WebAppReportView abstract base class.
     """
 
-    def __init__(self, identifier: int, name: str, report: r.Report, report_type: r.ReportType, columns: Optional[List[str]]):
-        super().__init__(identifier, name=name, report=report, report_type = r.ReportType.STREAMLIT, columns=columns)
+    BASE_DIR = 'streamlit_report'
+    SECTIONS_DIR = os.path.join(BASE_DIR, 'sections')
+    STATIC_FILES_DIR = os.path.join(BASE_DIR, 'static')
+
+    def __init__(self, id: int, name: str, report: r.Report, report_type: r.ReportType, columns: Optional[List[str]]):
+        super().__init__(id, name=name, report=report, report_type = report_type, columns=columns)
 
-    def generate_report(self, output_dir: str = 'streamlit_report/sections') -> None:
+    def generate_report(self, output_dir: str = SECTIONS_DIR) -> None:
         """
         Generates the Streamlit report and creates Python files for each section and its subsections and plots.
 
         Parameters
         ----------
         output_dir : str, optional
-            The folder where the generated report files will be saved (default is 'streamlit_report/sections').
+            The folder where the generated report files will be saved (default is SECTIONS_DIR).
         """
         # Create the output folder if it does not exist
         if not os.path.exists(output_dir):
@@ -82,14 +71,14 @@ def generate_report(self, output_dir: str = 'streamlit_report/sections') -> None
         # Create Python files for each section and its subsections and plots
         self._generate_sections(output_dir=output_dir)
 
-    def run_report(self, output_dir: str = 'sections') -> None:
+    def run_report(self, output_dir: str = SECTIONS_DIR) -> None:
         """
         Runs the generated Streamlit report.
 
         Parameters
         ----------
         output_dir : str, optional
-            The folder where the report was generated (default is 'sections').
+            The folder where the report was generated (default is SECTIONS_DIR).
         """
         sys.argv = ["streamlit", "run", os.path.join(output_dir, "report_manager.py")]
         sys.exit(stcli.main())
@@ -224,7 +213,7 @@ def _generate_subsection(self, subsection) -> tuple[List[str], List[str]]:
                 subsection_content.extend(self._generate_markdown_content(component))
         return subsection_content, subsection_imports
 
-    def _generate_plot_content(self, plot) -> List[str]:
+    def _generate_plot_content(self, plot, output_dir: str = STATIC_FILES_DIR) -> List[str]:
         """
         Generate content for a plot component based on the plot type (static or interactive).
         
@@ -237,7 +226,13 @@ def _generate_plot_content(self, plot) -> List[str]:
         -------
         list : List[str]
             The list of content lines for the plot.
+        output_dir : str, optional
+            The folder where the static files will be saved (default is STATIC_FILES_DIR).
         """
+        # Create the output folder if it does not exist
+        if not os.path.exists(output_dir):
+            os.mkdir(output_dir)
+        
         plot_content = []
         plot_content.append(self._format_text(text=plot.title, type='header', level=4, color='#2b8cbe'))
 
@@ -250,7 +245,8 @@ def _generate_plot_content(self, plot) -> List[str]:
             elif plot.int_visualization_tool == r.IntVisualizationTool.PYVIS:
                 # For PyVis, handle the network visualization
                 G = plot.read_network()
-                html_plot_file = f"streamlit_report/{plot.name.replace(' ', '_')}.html"
+                #html_plot_file = f"{output_dir}/{plot.name.replace(' ', '_')}.html"
+                html_plot_file = os.path.join(output_dir, f"{plot.name.replace(' ', '_')}.html")
                 net = plot.create_and_save_pyvis_network(G, html_plot_file)
                 num_nodes = len(net.nodes)
                 num_edges = len(net.edges)