🎨🐛 fix and improve type anntoations

Author: enryH

docs/conf.py

@@ -79,6 +79,8 @@
 # Intersphinx options
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
+    "networkx": ("https://networkx.org/documentation/stable/", None),
+    "pyvis": ("https://pyvis.readthedocs.io/en/stable/", None),
     # "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
     # "scikit-learn": ("https://scikit-learn.org/stable/", None),
     # "matplotlib": ("https://matplotlib.org/stable/", None),

vuegen/config_manager.py

@@ -1,3 +1,6 @@
+import logging
+from typing import Optional
+
 from . import report as r
 from .utils import assert_enum_value, get_logger
 
@@ -6,7 +9,7 @@ class ConfigManager:
     """
     Class for handling metadata of reports from YAML config file and creating report objects.
     """
-    def __init__(self, logger=None):
+    def __init__(self, logger: Optional[logging.Logger]=None):
         """
         Initializes the ConfigManager with a logger.
 

vuegen/utils.py

@@ -434,16 +434,18 @@ def get_basename(fname: None | str = None) -> str:
     - For a given filename, returns basename WITHOUT file extension
     - If no fname given (i.e., None) then return basename that the function is called in
 
-    PARAMS
-    -----
-    - fname (None or str): the filename to get basename of, or None
+    Parameters
+    ----------
+    fname: str, optional
+        The filename to get basename from. Default is None.
 
-    OUTPUTS
-    -----
-    - basename of given filepath or the current file the function is executed
+    Returns
+    -------
+    str
+        basename of given filepath or the current file the function is executed
 
     Examples
-    -----
+    ---------
     1)
     >>> get_basename()
     utils
@@ -467,17 +469,18 @@ def get_time(incl_time: bool = True, incl_timezone: bool = True) -> str:
     Gets current date, time (optional) and timezone (optional) for file naming
 
     Parameters
-    -----
+    ----------
     - incl_time (bool): whether to include timestamp in the string
     - incl_timezone (bool): whether to include the timezone in the string
 
     Returns
-    -----
-    - fname (str): includes date, timestamp and/or timezone
+    -------
+    str
+        fname that includes date, timestamp and/or timezone
         connected by '_' in one string e.g. yyyyMMdd_hhmm_timezone
 
     Examples
-    -----
+    --------
     1)
     >>> get_time()
     '20231019_101758_CEST'
@@ -530,13 +533,14 @@ def generate_log_filename(folder: str = "logs", suffix: str = "") -> str:
     Creates log file name and path
 
     Parameters
-    -----
+    ----------
     folder (str): name of the folder to put the log file in
     suffix (str): anything else you want to add to the log file name
 
     Returns
-    -----
-    log_filepath (str): the file path to the log file
+    -------
+    str
+        The file path to the log file
     """
     # PRECONDITIONS
     create_folder(folder)
@@ -548,7 +552,7 @@ def generate_log_filename(folder: str = "logs", suffix: str = "") -> str:
     return log_filepath
 
 
-def init_log(filename: str, display: bool = False, logger_id: str | None = None):
+def init_log(filename: str, display: bool = False, logger_id: str | None = None) -> logging.Logger:
     """
     - Custom python logger configuration (basicConfig())
         with two handlers (for stdout and for file)
@@ -557,15 +561,16 @@ def init_log(filename: str, display: bool = False, logger_id: str | None = None)
         display in stdout
 
     Parameters
-    -----
-    - filename (str): filepath to log record file
+    ----------
+    filename (str): filepath to log record file
     - display (bool): whether to print the logs to whatever standard output
     - logger_id (str): an optional identifier for yourself,
         if None then defaults to 'root'
 
     Returns
-    -----
-    - logger object
+    -------
+    logging.Logger
+        The logger object
 
     Examples
     -----