🎨 Style(streamlit_reportview.py): use Papth lib for all paths in the streamlit reports

Author: sayalaruano

src/vuegen/report.py

@@ -382,7 +382,7 @@ def create_and_save_pyvis_network(self, G: nx.Graph, output_file: str) -> Networ
             net.show_buttons(filter_=["physics"])
 
             # Save the network as an HTML file
-            net.save_graph(output_file)
+            net.save_graph(str(output_file))
             self.logger.info(f"PyVis network created and saved as: {output_file}.")
             return net
 

src/vuegen/streamlit_reportview.py

@@ -15,8 +15,8 @@ class StreamlitReportView(r.WebAppReportView):
     """
 
     BASE_DIR = "streamlit_report"
-    SECTIONS_DIR = os.path.join(BASE_DIR, "sections")
-    STATIC_FILES_DIR = os.path.join(BASE_DIR, "static")
+    SECTIONS_DIR = Path(BASE_DIR) / "sections"
+    STATIC_FILES_DIR = Path(BASE_DIR) / "static"
     REPORT_MANAG_SCRIPT = "report_manager.py"
 
     def __init__(
@@ -94,7 +94,7 @@ def generate_report(
                 # Create a folder for each section
                 subsection_page_vars = []
                 section_name_var = section.title.replace(" ", "_")
-                section_dir_path = os.path.join(output_dir, section_name_var)
+                section_dir_path = Path(output_dir) / section_name_var
 
                 if create_folder(section_dir_path):
                     self.report.logger.debug(
@@ -130,7 +130,7 @@ def generate_report(
 
             # Write the navigation and general content to a Python file
             with open(
-                os.path.join(output_dir, self.REPORT_MANAG_SCRIPT), "w"
+                Path(output_dir) / self.REPORT_MANAG_SCRIPT, "w"
             ) as nav_manager:
                 nav_manager.write("\n".join(report_manag_content))
                 self.report.logger.info(
@@ -163,7 +163,7 @@ def run_report(self, output_dir: str = SECTIONS_DIR) -> None:
                     [
                         "streamlit",
                         "run",
-                        os.path.join(output_dir, self.REPORT_MANAG_SCRIPT),
+                        Path(output_dir) / self.REPORT_MANAG_SCRIPT,
                     ],
                     check=True,
                 )
@@ -181,12 +181,12 @@ def run_report(self, output_dir: str = SECTIONS_DIR) -> None:
                 f"To run the Streamlit app, use the following command:"
             )
             self.report.logger.info(
-                f"streamlit run {os.path.join(output_dir, self.REPORT_MANAG_SCRIPT)}"
+                f"streamlit run {Path(output_dir) / self.REPORT_MANAG_SCRIPT}"
             )
             msg = (
                 f"\nAll the scripts to build the Streamlit app are available at: {output_dir}\n\n"
                 f"To run the Streamlit app, use the following command:\n\n"
-                f"\tstreamlit run {os.path.join(output_dir, self.REPORT_MANAG_SCRIPT)}"
+                f"\tstreamlit run {Path(output_dir) / self.REPORT_MANAG_SCRIPT}"
             )
             print(msg)
 
@@ -243,7 +243,7 @@ def _generate_home_section(
 
         try:
             # Create folder for the home page
-            home_dir_path = os.path.join(output_dir, "Home")
+            home_dir_path = Path(output_dir) / "Home"
             if create_folder(home_dir_path):
                 self.report.logger.debug(f"Created home directory: {home_dir_path}")
             else:
@@ -268,7 +268,7 @@ def _generate_home_section(
             home_content.append("st.markdown(footer, unsafe_allow_html=True)\n")
 
             # Write the home page content to a Python file
-            home_page_path = os.path.join(home_dir_path, "Homepage.py")
+            home_page_path = Path(home_dir_path) / "Homepage.py"
             with open(home_page_path, "w") as home_page:
                 home_page.write("\n".join(home_content))
             self.report.logger.info(f"Home page content written to '{home_page_path}'.")
@@ -309,11 +309,7 @@ def _generate_sections(self, output_dir: str) -> None:
                         )
                         try:
                             # Create subsection file
-                            subsection_file_path = os.path.join(
-                                output_dir,
-                                section_name_var,
-                                subsection.title.replace(" ", "_") + ".py",
-                            )
+                            subsection_file_path = Path(output_dir) / section_name_var / f"{subsection.title.replace(' ', '_')}.py"
 
                             # Generate content and imports for the subsection
                             subsection_content, subsection_imports = (
@@ -461,9 +457,7 @@ def _generate_plot_content(
                     networkx_graph, html_plot_file = networkx_graph
                 else:
                     # Otherwise, create and save a new pyvis network from the netowrkx graph
-                    html_plot_file = os.path.join(
-                        static_dir, f"{plot.title.replace(' ', '_')}.html"
-                    )
+                    html_plot_file = Path(static_dir) / f"{plot.title.replace(' ', '_')}.html"
                     pyvis_graph = plot.create_and_save_pyvis_network(
                         networkx_graph, html_plot_file
                     )
@@ -532,7 +526,7 @@ def _generate_plot_code(self, plot) -> str:
 plot_json = json.loads(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 = json.load(plot_file)\n"""
 
         # Add specific code for each visualization tool
@@ -585,7 +579,7 @@ def _generate_dataframe_content(self, dataframe) -> 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
             ):
@@ -675,7 +669,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"""
                 )
             # Code to display md content
@@ -735,7 +729,7 @@ def _generate_html_content(self, html) -> List[str]:
                 # If it's a local file
                 html_content.append(
                     f"""
-with open('{os.path.join("..", html.file_path)}', 'r', encoding='utf-8') as html_file:
+with open('{Path("..") / html.file_path}', 'r', encoding='utf-8') as html_file:
     html_content = html_file.read()\n"""
                 )
 

src/vuegen/utils.py

@@ -24,27 +24,20 @@
 
 
 ## CHECKS
-def check_path(filepath: str) -> bool:
+def check_path(filepath: Path) -> bool:
     """
     Checks if the given file or folder path exists.
 
     Parameters
     ---------
-    filepath : str
+    filepath : Path
         The file or folder path to check.
 
     Returns
     -------
     bool
         True if the path exists, False otherwise.
-
-    Raises
-    ------
-    AssertionError
-        If the filepath is not a valid string.
     """
-    # Assert that the filepath is a string
-    assert isinstance(filepath, str), f"Filepath must be a string: {filepath}"
 
     # Check if the path exists
     return os.path.exists(os.path.abspath(filepath))
@@ -87,13 +80,13 @@ def assert_enum_value(
         )
 
 
-def is_url(filepath: str) -> bool:
+def is_url(filepath: Path) -> bool:
     """
     Check if the provided path is a valid URL.
 
     Parameters
     ----------
-    filepath : str
+    filepath : Path
         The filepath to check.
 
     Returns
@@ -102,17 +95,9 @@ def is_url(filepath: str) -> bool:
         True if the input path is a valid URL, meaning it contains both a scheme
         (e.g., http, https, ftp) and a network location (e.g., example.com).
         Returns False if either the scheme or the network location is missing or invalid.
-
-    Raises
-    ------
-    AssertionError
-        If the filepath is not a valid string.
     """
-    # Assert that the filepath is a string
-    assert isinstance(filepath, str), f"Filepath must be a string: {filepath}"
-
     # Parse the url and return validation
-    parsed_url = urlparse(filepath)
+    parsed_url = urlparse(str(filepath))
     return bool(parsed_url.scheme and parsed_url.netloc)