🎨 Style(quarto_reportview.py): use Path lib for all paths in the quarto reports

Author: sayalaruano

src/vuegen/quarto_reportview.py

@@ -16,7 +16,7 @@ class QuartoReportView(r.ReportView):
     """
 
     BASE_DIR = "quarto_report"
-    STATIC_FILES_DIR = os.path.join(BASE_DIR, "static")
+    STATIC_FILES_DIR = Path(BASE_DIR) / "static"
 
     def __init__(self, report: r.Report, report_type: r.ReportType):
         super().__init__(report=report, report_type=report_type)
@@ -125,7 +125,7 @@ def generate_report(
 
             # Write the navigation and general content to a Python file
             with open(
-                os.path.join(output_dir, f"{self.BASE_DIR}.qmd"), "w"
+                Path(output_dir) / f"{self.BASE_DIR}.qmd", "w"
             ) as quarto_report:
                 quarto_report.write(yaml_header)
                 quarto_report.write(
@@ -156,15 +156,15 @@ def run_report(self, output_dir: str = BASE_DIR) -> None:
         """
         try:
             subprocess.run(
-                ["quarto", "render", os.path.join(output_dir, f"{self.BASE_DIR}.qmd")],
+                ["quarto", "render", Path(output_dir) / f"{self.BASE_DIR}.qmd"],
                 check=True,
             )
             if self.report_type == r.ReportType.JUPYTER:
                 subprocess.run(
                     [
                         "quarto",
                         "convert",
-                        os.path.join(output_dir, f"{self.BASE_DIR}.qmd"),
+                        Path(output_dir) / f"{self.BASE_DIR}.qmd",
                     ],
                     check=True,
                 )
@@ -413,13 +413,9 @@ def _generate_plot_content(
 
         # Define plot path
         if is_report_static:
-            static_plot_path = os.path.join(
-                static_dir, f"{plot.title.replace(' ', '_')}.png"
-            )
+            static_plot_path = Path(static_dir) / f"{plot.title.replace(' ', '_')}.png"
         else:
-            html_plot_file = os.path.join(
-                static_dir, f"{plot.title.replace(' ', '_')}.html"
-            )
+            html_plot_file = Path(static_dir) / f"{plot.title.replace(' ', '_')}.html"
 
         # Add content for the different plot types
         try:
@@ -431,7 +427,7 @@ def _generate_plot_content(
                 plot_content.append(self._generate_plot_code(plot))
                 if is_report_static:
                     plot_content.append(
-                        f"""fig_plotly.write_image("{os.path.abspath(static_plot_path)}")\n```\n"""
+                        f"""fig_plotly.write_image("{static_plot_path.resolve()}")\n```\n"""
                     )
                     plot_content.append(self._generate_image_content(static_plot_path))
                 else:
@@ -440,7 +436,7 @@ def _generate_plot_content(
                 plot_content.append(self._generate_plot_code(plot))
                 if is_report_static:
                     plot_content.append(
-                        f"""fig_altair.save("{os.path.abspath(static_plot_path)}")\n```\n"""
+                        f"""fig_altair.save("{static_plot_path.resolve()}")\n```\n"""
                     )
                     plot_content.append(self._generate_image_content(static_plot_path))
                 else:
@@ -513,7 +509,7 @@ def _generate_plot_code(self, plot, output_file="") -> str:
 plot_json = response.text\n"""
         else:  # If it's a local file
             plot_code += f"""
-with open('{os.path.join("..", plot.file_path)}', 'r') as plot_file:
+with open('{Path("..") / plot.file_path}', 'r') as plot_file:
     plot_json = plot_file.read()\n"""
         # Add specific code for each visualization tool
         if plot.plot_type == r.PlotType.PLOTLY:
@@ -527,7 +523,7 @@ def _generate_plot_code(self, plot, output_file="") -> str:
             if is_url(plot.file_path) and plot.file_path.endswith(".html"):
                 iframe_src = output_file
             else:
-                iframe_src = os.path.join("..", output_file)
+                iframe_src = Path("..") / output_file
 
             # Embed the HTML file in an iframe
             plot_code = f"""
@@ -573,7 +569,7 @@ def _generate_dataframe_content(self, dataframe, is_report_static) -> List[str]:
         }
         try:
             # Check if the file extension matches any DataFrameFormat value
-            file_extension = os.path.splitext(dataframe.file_path)[1].lower()
+            file_extension = Path(dataframe.file_path).suffix.lower()
             if not any(
                 file_extension == fmt.value_with_dot for fmt in r.DataFrameFormat
             ):
@@ -585,7 +581,7 @@ def _generate_dataframe_content(self, dataframe, is_report_static) -> List[str]:
             file_path = (
                 dataframe.file_path
                 if is_url(dataframe.file_path)
-                else os.path.join("..", dataframe.file_path)
+                else Path("..") / dataframe.file_path
             )
 
             # Load the DataFrame using the correct function
@@ -648,7 +644,7 @@ def _generate_markdown_content(self, markdown) -> List[str]:
             else:  # If it's a local file
                 markdown_content.append(
                     f"""
-with open('{os.path.join("..", markdown.file_path)}', 'r') as markdown_file:
+with open('{Path("..") / markdown.file_path}', 'r') as markdown_file:
     markdown_content = markdown_file.read()\n"""
                 )
 
@@ -694,7 +690,7 @@ def _generate_html_content(self, html) -> List[str]:
             iframe_src = (
                 html.file_path
                 if is_url(html.file_path)
-                else os.path.join("..", html.file_path)
+                else Path("..") / html.file_path
             )
             iframe_code = f"""
 <div style="text-align: center;">
@@ -769,11 +765,9 @@ def _show_dataframe(
         dataframe_content = []
         if is_report_static:
             # Generate path for the DataFrame image
-            df_image = os.path.join(
-                static_dir, f"{dataframe.title.replace(' ', '_')}.png"
-            )
+            df_image = Path(static_dir) / f"{dataframe.title.replace(' ', '_')}.png"
             dataframe_content.append(
-                f"df.dfi.export('{os.path.abspath(df_image)}', max_rows=10, max_cols=5)\n```\n"
+                f"df.dfi.export('{Path(df_image).resolve()}', 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))