From e0fa378346b792e47f552a5cbf77a2c7c2fc89c9 Mon Sep 17 00:00:00 2001 From: Nate Kean <14845347+garlic-os@users.noreply.github.com> Date: Thu, 18 Jul 2024 20:50:15 -0500 Subject: [PATCH] Lint logger.py - Added type annotations - Missing docstrings (D100, D101, D102, D103, D107) ignored for now --- tools/RAiDER/logger.py | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/tools/RAiDER/logger.py b/tools/RAiDER/logger.py index 483b58b0..595b5930 100644 --- a/tools/RAiDER/logger.py +++ b/tools/RAiDER/logger.py @@ -9,9 +9,9 @@ import logging import os -from pathlib import Path import sys -from logging import FileHandler, Formatter, StreamHandler +from logging import FileHandler, Formatter, LogRecord, StreamHandler +from pathlib import Path import RAiDER.cli.conf as conf @@ -26,14 +26,14 @@ class UnixColorFormatter(Formatter): COLORS = {logging.WARNING: yellow, logging.ERROR: red, logging.CRITICAL: bold_red} - def __init__(self, fmt=None, datefmt=None, style='%', use_color=True) -> None: + def __init__(self, fmt: str = None, datefmt: str = None, style: str = '%', use_color: bool=True) -> None: super().__init__(fmt, datefmt, style) # Save the old function so we can call it later self.__formatMessage = self.formatMessage if use_color: self.formatMessage = self.formatMessageColor - def formatMessageColor(self, record): + def formatMessageColor(self, record: LogRecord) -> str: message = self.__formatMessage(record) color = self.COLORS.get(record.levelno) if color: @@ -43,8 +43,7 @@ def formatMessageColor(self, record): class CustomFormatter(UnixColorFormatter): """Adds levelname prefixes to the message on warning or above.""" - - def formatMessage(self, record): + def formatMessage(self, record: LogRecord) -> str: message = super().formatMessage(record) if record.levelno >= logging.WARNING: message = ': '.join((record.levelname, message)) @@ -53,10 +52,10 @@ def formatMessage(self, record): ##################################### # DEFINE THE LOGGER -if conf.LOGGER_PATH is None: - logger_path = Path.cwd() -else: +if conf.LOGGER_PATH is not None: logger_path = conf.LOGGER_PATH +else: + logger_path = Path.cwd() logger = logging.getLogger('RAiDER') logger.setLevel(logging.DEBUG)