[PATCH] Formatting changes

Author: Diapolo10

pyproject.toml

@@ -106,70 +106,8 @@ testpaths = [
 
 
 [tool.ruff]
-lint.select = [
-    "A",     # Builtins
-    # "AIR",   # Airflow
-    "ANN",   # Annotations
-    "ARG",   # Unused arguments
-    "ASYNC", # Asynchronous code
-    "B",     # Bugbear
-    "BLE",   # Blind except
-    "C4",    # Comprehensions
-    "C90",   # mccabe
-    "COM",   # Commas
-    # "CPY",   # Copyright
-    "D1",    # Undocumented public elements
-    "D2",    # Docstring conventions
-    "D3",    # Triple double quotes
-    "D4",    # Docstring text format
-    # "DJ",    # Django
-    "DTZ",   # Datetimes
-    "E",     # Errors
-    "EM",    # Error messages
-    "ERA",   # Commented-out code
-    "EXE",   # Executable
-    "F",     # Pyflakes
-    "FA",    # __future__ annotations
-    # "FAST",  # FastAPI
-    "FBT",   # "Boolean trap"
-    "FIX",   # "FIXME"-comments
-    "FLY",   # F-strings
-    "FURB",  # Refurb
-    "G",     # Logging format
-    "I",     # Isort
-    "ICN",   # Import conventions
-    "INP",   # Disallow PEP-420 (Implicit namespace packages)
-    "INT",   # gettext
-    "ISC",   # Implicit str concat
-    "LOG",   # Logging
-    "N",     # PEP-8 Naming
-    # "NPY",   # Numpy
-    # "PD",    # Pandas
-    "PERF",  # Unnecessary performance costs
-    "PGH",   # Pygrep hooks
-    "PIE",   # Unnecessary code
-    "PL",    # Pylint
-    "PT",    # Pytest
-    "PTH",   # Use Pathlib
-    "PYI",   # Stub files
-    "Q",     # Quotes
-    "RET",   # Return
-    "RUF",   # Ruff
-    "RSE",   # Raise
-    "S",     # Bandit
-    "SIM",   # Code simplification
-    "SLF",   # Private member access
-    "SLOT",  # __slots__
-    "T10",   # Debugger
-    "T20",   # Print
-    "TC",   # Type checking
-    "TD",    # "TODO"-comments
-    "TID",   # Tidy imports
-    "TRY",   # Exception handling
-    "UP",    # Pyupgrade
-    "W",     # Warnings
-    "YTT",   # sys.version
-]
+lint.fixable = ["ALL"]
+lint.select = ["ALL"]
 lint.ignore = [
     "D203",    # One blank line before class docstring
     "D212",    # Multi-line summary first line

src/project_name/config.py

@@ -13,6 +13,6 @@
 PACKAGE_NAME = "project_name"
 
 with pkg_resources.as_file(pkg_resources.files(project_name)) as package_dir:
-    DEFAULT_CONFIG_FILE_PATH = package_dir / 'logger_config.toml'
+    DEFAULT_CONFIG_FILE_PATH = package_dir / "logger_config.toml"
 
 LOGGER_CONFIG_FILE = Path(os.environ.get("PROJECT_NAME_LOGGER_CONFIG_FILE", DEFAULT_CONFIG_FILE_PATH))

src/project_name/logger.py

@@ -22,7 +22,7 @@
 
 ROOT_LOGGER_NAME = PACKAGE_NAME
 
-__all__ = ('ROOT_LOGGER_NAME', 'setup_logging')
+__all__ = ("ROOT_LOGGER_NAME", "setup_logging")
 
 
 class RecordAttrs(str, Enum):
@@ -70,18 +70,16 @@ class ColouredFormatter(logging.Formatter):
     def format(self, record: logging.LogRecord) -> str:
         """Format the log record."""
         log_level_colours = {
-            logging.CRITICAL: '\033[31;1;40m',  # Red, bold
-            logging.ERROR: '\033[31;40m',       # Red
-            logging.WARNING: '\033[33;40m',     # Yellow
-            logging.INFO: '\033[32;40m',        # Green
-            logging.DEBUG: '\033[36;40m',       # Cyan
+            logging.CRITICAL: "\033[31;1;40m",  # Red, bold
+            logging.ERROR: "\033[31;40m",  # Red
+            logging.WARNING: "\033[33;40m",  # Yellow
+            logging.INFO: "\033[32;40m",  # Green
+            logging.DEBUG: "\033[36;40m",  # Cyan
         }
-        reset = '\033[0m'
+        reset = "\033[0m"
 
         record.msg = f"{log_level_colours.get(record.levelno, reset)}{record.msg}{reset}"
-        record.levelname = (
-            f"{log_level_colours.get(record.levelno, reset)}{record.levelname:^8}{reset}"
-        )
+        record.levelname = f"{log_level_colours.get(record.levelno, reset)}{record.levelname:^8}{reset}"
 
         return super().format(record)
 
@@ -122,11 +120,7 @@ class JSONLogFormatter(logging.Formatter):
     @override
     def __init__(self, *, fmt_keys: FormatKeys | None = None) -> None:
         super().__init__()
-        self.fmt_keys = (
-            fmt_keys
-            if fmt_keys is not None
-            else FormatKeys()
-        )
+        self.fmt_keys = fmt_keys if fmt_keys is not None else FormatKeys()
 
     @override
     def format(self, record: logging.LogRecord) -> str:
@@ -135,18 +129,18 @@ def format(self, record: logging.LogRecord) -> str:
 
     def _prepare_log_dict(self, record: logging.LogRecord) -> LogDict:
         required_fields: LogDict = {
-            'message': record.getMessage(),
-            'timestamp': dt.datetime.fromtimestamp(
+            "message": record.getMessage(),
+            "timestamp": dt.datetime.fromtimestamp(
                 record.created,
                 tz=dt.timezone.utc,
             ),
         }
 
         if record.exc_info is not None:
-            required_fields['exc_info'] = self.formatException(record.exc_info)
+            required_fields["exc_info"] = self.formatException(record.exc_info)
 
         if record.stack_info is not None:
-            required_fields['stack_info'] = self.formatStack(record.stack_info)
+            required_fields["stack_info"] = self.formatStack(record.stack_info)
 
         message: LogDict = {  # type: ignore[assignment]
             key: msg_val
@@ -166,8 +160,8 @@ def _prepare_log_dict(self, record: logging.LogRecord) -> LogDict:
 
 def setup_logging() -> None:
     """Set up logging."""
-    (Path.cwd() / 'logs').mkdir(exist_ok=True)
-    logger_data = LOGGER_CONFIG_FILE.read_text(encoding='utf-8')
+    (Path.cwd() / "logs").mkdir(exist_ok=True)
+    logger_data = LOGGER_CONFIG_FILE.read_text(encoding="utf-8")
     logging_config = tomllib.loads(logger_data)
     logging.config.dictConfig(logging_config)
 

src/project_name/main.py

@@ -11,7 +11,7 @@ def main() -> None:
     """Lorem Ipsum."""
     setup_logging()
 
-    logger.debug("debug message", extra={'foo': 'hello'})
+    logger.debug("debug message", extra={"foo": "hello"})
     logger.info("info message")
     logger.warning("warning message")
     logger.error("error message")
@@ -23,5 +23,5 @@ def main() -> None:
         logger.exception("exception message")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()