🐛 set default static dir only on main methods, pass parameter on other hidden methods

- will allow to set static dir on app or cli

Author: enryH

src/vuegen/quarto_reportview.py

@@ -113,7 +113,10 @@ def generate_report(
                         # Generate content for the subsection
                         subsection_content, subsection_imports = (
                             self._generate_subsection(
-                                subsection, is_report_static, is_report_revealjs
+                                subsection,
+                                is_report_static,
+                                is_report_revealjs,
+                                static_dir=static_dir,
                             )
                         )
                         qmd_content.extend(subsection_content)
@@ -352,7 +355,11 @@ def _create_yaml_header(self) -> str:
         return yaml_header
 
     def _generate_subsection(
-        self, subsection, is_report_static, is_report_revealjs
+        self,
+        subsection,
+        is_report_static,
+        is_report_revealjs,
+        static_dir: str,
     ) -> tuple[List[str], List[str]]:
         """
         Generate code to render components (plots, dataframes, markdown) in the given subsection,
@@ -366,6 +373,8 @@ def _generate_subsection(
             A boolean indicating whether the report is static or interactive.
         is_report_revealjs : bool
             A boolean indicating whether the report is in revealjs format.
+        static_dir : str
+            The folder where the static files will be saved.
         Returns
         -------
         tuple : (List[str], List[str])
@@ -389,11 +398,15 @@ def _generate_subsection(
 
             if component.component_type == r.ComponentType.PLOT:
                 subsection_content.extend(
-                    self._generate_plot_content(component, is_report_static)
+                    self._generate_plot_content(
+                        component, is_report_static, static_dir=static_dir
+                    )
                 )
             elif component.component_type == r.ComponentType.DATAFRAME:
                 subsection_content.extend(
-                    self._generate_dataframe_content(component, is_report_static)
+                    self._generate_dataframe_content(
+                        component, is_report_static, static_dir=static_dir
+                    )
                 )
             elif (
                 component.component_type == r.ComponentType.MARKDOWN
@@ -419,7 +432,7 @@ def _generate_subsection(
         return subsection_content, subsection_imports
 
     def _generate_plot_content(
-        self, plot, is_report_static, static_dir: str = STATIC_FILES_DIR
+        self, plot, is_report_static, static_dir: str
     ) -> List[str]:
         """
         Generate content for a plot component based on the report type.
@@ -428,8 +441,8 @@ def _generate_plot_content(
         ----------
         plot : Plot
             The plot component to generate content for.
-        static_dir : str, optional
-            The folder where the static files will be saved (default is STATIC_FILES_DIR).
+        static_dir : str
+            The folder where the static files will be saved.
 
         Returns
         -------
@@ -561,7 +574,9 @@ def _generate_plot_code(self, plot, output_file="") -> str:
 </div>\n"""
         return plot_code
 
-    def _generate_dataframe_content(self, dataframe, is_report_static) -> List[str]:
+    def _generate_dataframe_content(
+        self, dataframe, is_report_static, static_dir: str
+    ) -> List[str]:
         """
         Generate content for a DataFrame component based on the report type.
 
@@ -571,6 +586,8 @@ def _generate_dataframe_content(self, dataframe, is_report_static) -> List[str]:
             The dataframe component to add to content.
         is_report_static : bool
             A boolean indicating whether the report is static or interactive.
+        static_dir : str
+            The folder where the static files will be saved.
 
         Returns
         -------
@@ -620,7 +637,9 @@ def _generate_dataframe_content(self, dataframe, is_report_static) -> List[str]:
             )
 
             # Display the dataframe
-            dataframe_content.extend(self._show_dataframe(dataframe, is_report_static))
+            dataframe_content.extend(
+                self._show_dataframe(dataframe, is_report_static, static_dir=static_dir)
+            )
 
         except Exception as e:
             self.report.logger.error(
@@ -772,7 +791,7 @@ def _generate_image_content(
             )
 
     def _show_dataframe(
-        self, dataframe, is_report_static, static_dir: str = STATIC_FILES_DIR
+        self, dataframe, is_report_static, static_dir: str
     ) -> List[str]:
         """
         Appends either a static image or an interactive representation of a DataFrame to the content list.
@@ -783,8 +802,8 @@ def _show_dataframe(
             The DataFrame object containing the data to display.
         is_report_static : bool
             Determines if the report is in a static format (e.g., PDF) or interactive (e.g., HTML).
-        static_dir : str, optional
-            The folder where the static files will be saved (default is STATIC_FILES_DIR).
+        static_dir : str
+            The folder where the static files will be saved.
 
         Returns
         -------

src/vuegen/streamlit_reportview.py

@@ -144,7 +144,7 @@ def generate_report(
                 )
 
             # Create Python files for each section and its subsections and plots
-            self._generate_sections(output_dir=output_dir)
+            self._generate_sections(output_dir=output_dir, static_dir=static_dir)
         except Exception as e:
             self.report.logger.error(
                 f"An error occurred while generating the report: {str(e)}"
@@ -308,14 +308,16 @@ def _generate_home_section(
             self.report.logger.error(f"Error generating the home section: {str(e)}")
             raise
 
-    def _generate_sections(self, output_dir: str) -> None:
+    def _generate_sections(self, output_dir: str, static_dir: str) -> None:
         """
         Generates Python files for each section in the report, including subsections and its components (plots, dataframes, markdown).
 
         Parameters
         ----------
         output_dir : str
             The folder where section files will be saved.
+        static_dir : str
+            The folder where the static files will be saved.
         """
         self.report.logger.info("Starting to generate sections for the report.")
 
@@ -342,7 +344,9 @@ def _generate_sections(self, output_dir: str) -> None:
 
                             # Generate content and imports for the subsection
                             subsection_content, subsection_imports = (
-                                self._generate_subsection(subsection)
+                                self._generate_subsection(
+                                    subsection, static_dir=static_dir
+                                )
                             )
 
                             # Flatten the subsection_imports into a single list
@@ -379,7 +383,9 @@ def _generate_sections(self, output_dir: str) -> None:
             self.report.logger.error(f"Error generating sections: {str(e)}")
             raise
 
-    def _generate_subsection(self, subsection) -> tuple[List[str], List[str]]:
+    def _generate_subsection(
+        self, subsection, static_dir
+    ) -> tuple[List[str], List[str]]:
         """
         Generate code to render components (plots, dataframes, markdown) in the given subsection,
         creating imports and content for the subsection based on the component type.
@@ -388,6 +394,8 @@ def _generate_subsection(self, subsection) -> tuple[List[str], List[str]]:
         ----------
         subsection : Subsection
             The subsection containing the components.
+        static_dir : str
+            The folder where the static files will be saved.
 
         Returns
         -------
@@ -416,7 +424,9 @@ def _generate_subsection(self, subsection) -> tuple[List[str], List[str]]:
 
             # Handle different types of components
             if component.component_type == r.ComponentType.PLOT:
-                subsection_content.extend(self._generate_plot_content(component))
+                subsection_content.extend(
+                    self._generate_plot_content(component, static_dir=static_dir)
+                )
             elif component.component_type == r.ComponentType.DATAFRAME:
                 subsection_content.extend(self._generate_dataframe_content(component))
             # If md files is called "description.md", do not include it in the report
@@ -445,9 +455,7 @@ def _generate_subsection(self, subsection) -> tuple[List[str], List[str]]:
         )
         return subsection_content, subsection_imports
 
-    def _generate_plot_content(
-        self, plot, static_dir: str = STATIC_FILES_DIR
-    ) -> List[str]:
+    def _generate_plot_content(self, plot, static_dir: str) -> List[str]:
         """
         Generate content for a plot component based on the plot type (static or interactive).
 
@@ -460,8 +468,8 @@ def _generate_plot_content(
         -------
         list : List[str]
             The list of content lines for the plot.
-        static_dir : str, optional
-            The folder where the static files will be saved (default is STATIC_FILES_DIR).
+        static_dir : str
+            The folder where the static files will be saved.
         """
         plot_content = []
         # Add title