add TypeHint

Author: KazunoriSumiya

mct_quantizers/logger.py

@@ -18,6 +18,7 @@
 import os
 from datetime import datetime
 from pathlib import Path
+from typing import Optional
 
 LOGGER_NAME = 'MCT Quantizers'
 
@@ -32,7 +33,7 @@ class Logger:
     CRITICAL = logging.CRITICAL
 
     @staticmethod
-    def __check_path_create_dir(log_path: str):
+    def __check_path_create_dir(log_path: str) -> None:
         """
         Create a path if not exist. Otherwise, do nothing.
 
@@ -44,7 +45,7 @@ def __check_path_create_dir(log_path: str):
             Path(log_path).mkdir(parents=True, exist_ok=True)
 
     @staticmethod
-    def set_logger_level(log_level=logging.INFO):
+    def set_logger_level(log_level: int = logging.INFO) -> None:
         """
         Set log level to determine the logger verbosity.
 
@@ -56,7 +57,7 @@ def set_logger_level(log_level=logging.INFO):
         logger.setLevel(log_level)
 
     @staticmethod
-    def set_handler_level(log_level=logging.INFO):
+    def set_handler_level(log_level: int = logging.INFO) -> None:
         """
         Set log level for all handlers attached to the logger.
 
@@ -69,14 +70,14 @@ def set_handler_level(log_level=logging.INFO):
             handler.setLevel(log_level)
 
     @staticmethod
-    def get_logger():
+    def get_logger() -> logging.Logger:
         """
         Returns: An instance of the logger.
         """
         return logging.getLogger(LOGGER_NAME)
 
     @staticmethod
-    def set_stream_handler():
+    def set_stream_handler() -> None:
         """
         Add a StreamHandler to output logs to the console (stdout).
         """
@@ -92,7 +93,7 @@ def set_stream_handler():
         logger.addHandler(sh)
 
     @staticmethod
-    def set_log_file(log_folder: str = None):
+    def set_log_file(log_folder: Optional[str] = None) -> None:
         """
         Setting the logger log file path. The method gets the folder for the log file.
         In that folder, it creates a log file according to the timestamp.
@@ -119,7 +120,7 @@ def set_log_file(log_folder: str = None):
         print(f'log file is in {log_name}')
 
     @staticmethod
-    def shutdown():
+    def shutdown() -> None:
         """
         An orderly command to shutdown by flushing and closing all logging handlers.
         """
@@ -131,7 +132,7 @@ def shutdown():
     ########################################
 
     @staticmethod
-    def critical(msg: str):
+    def critical(msg: str) -> None:
         """
         Log a message at 'critical' severity and raise an exception.
 
@@ -142,7 +143,7 @@ def critical(msg: str):
         raise Exception(msg)
 
     @staticmethod
-    def exception(msg: str):
+    def exception(msg: str) -> None:
         """
         Log a message at 'exception' severity and raise an exception.
 
@@ -153,7 +154,7 @@ def exception(msg: str):
         raise Exception(msg)
 
     @staticmethod
-    def debug(msg: str):
+    def debug(msg: str) -> None:
         """
         Log a message at 'debug' severity.
 
@@ -163,7 +164,7 @@ def debug(msg: str):
         Logger.get_logger().debug(msg)
 
     @staticmethod
-    def info(msg: str):
+    def info(msg: str) -> None:
         """
         Log a message at 'info' severity.
 
@@ -173,7 +174,7 @@ def info(msg: str):
         Logger.get_logger().info(msg)
 
     @staticmethod
-    def warning(msg: str):
+    def warning(msg: str) -> None:
         """
         Log a message at 'warning' severity.
 
@@ -183,7 +184,7 @@ def warning(msg: str):
         Logger.get_logger().warning(msg)
 
     @staticmethod
-    def error(msg: str):
+    def error(msg: str) -> None:
         """
         Log a message at 'error' severity and raise an exception.
 
@@ -193,7 +194,7 @@ def error(msg: str):
         Logger.get_logger().error(msg)
 
 
-def set_log_folder(folder: str, level: int = logging.INFO):
+def set_log_folder(folder: str, level: int = logging.INFO) -> None:
     """
     Set a directory path for saving a log file.