fix: add type hints to logger method arguments for better clarity

Author: KazunoriSumiya

mct_quantizers/logger.py

@@ -38,7 +38,7 @@ def __check_path_create_dir(log_path: str) -> None:
         Create a path if not exist. Otherwise, do nothing.
 
         Args:
-            log_path: Path to create or verify that exists.
+            log_path (str): Path to create or verify that exists.
         """
 
         if not os.path.exists(log_path):
@@ -50,7 +50,7 @@ def set_logger_level(log_level: int = logging.INFO) -> None:
         Set log level to determine the logger verbosity.
 
         Args:
-            log_level: Level of verbosity to set for the logger.
+            log_level (int): Level of verbosity to set for the logger.
         """
 
         logger = Logger.get_logger()
@@ -62,7 +62,7 @@ def set_handler_level(log_level: int = logging.INFO) -> None:
         Set log level for all handlers attached to the logger.
 
         Args:
-            log_level: Level of verbosity to set for the handlers.
+            log_level (int): Level of verbosity to set for the handlers.
         """
 
         logger = Logger.get_logger()
@@ -99,7 +99,7 @@ def set_log_file(log_folder: Optional[str] = None) -> None:
         In that folder, it creates a log file according to the timestamp.
 
         Args:
-            log_folder: Folder path to hold the log file.
+            log_folder (Optional[str]): Folder path to hold the log file.
         """
 
         logger = Logger.get_logger()
@@ -137,7 +137,7 @@ def critical(msg: str) -> None:
         Log a message at 'critical' severity and raise an exception.
 
         Args:
-            msg: Message to log.
+            msg (str): Message to log.
         """
         Logger.get_logger().critical(msg)
         raise Exception(msg)
@@ -148,7 +148,7 @@ def exception(msg: str) -> None:
         Log a message at 'exception' severity and raise an exception.
 
         Args:
-            msg: Message to log.
+            msg (str): Message to log.
         """
         Logger.get_logger().exception(msg)
         raise Exception(msg)
@@ -159,7 +159,7 @@ def debug(msg: str) -> None:
         Log a message at 'debug' severity.
 
         Args:
-            msg: Message to log.
+            msg (str): Message to log.
         """
         Logger.get_logger().debug(msg)
 
@@ -169,7 +169,7 @@ def info(msg: str) -> None:
         Log a message at 'info' severity.
 
         Args:
-            msg: Message to log.
+            msg (str): Message to log.
         """
         Logger.get_logger().info(msg)
 
@@ -179,7 +179,7 @@ def warning(msg: str) -> None:
         Log a message at 'warning' severity.
 
         Args:
-            msg: Message to log.
+            msg (str): Message to log.
         """
         Logger.get_logger().warning(msg)
 
@@ -189,7 +189,7 @@ def error(msg: str) -> None:
         Log a message at 'error' severity and raise an exception.
 
         Args:
-            msg: Message to log.
+            msg (str): Message to log.
         """
         Logger.get_logger().error(msg)
 
@@ -199,8 +199,8 @@ def set_log_folder(folder: str, level: int = logging.INFO) -> None:
     Set a directory path for saving a log file.
 
     Args:
-        folder: Folder path to save the log file.
-        level: Level of verbosity to set to the logger and handlers.
+        folder (str): Folder path to save the log file.
+        level (int): Level of verbosity to set to the logger and handlers.
 
     Note:
         This is a convenience function that calls multiple Logger methods