custom-python-logger 2.0.3__py3-none-any.whl → 2.0.4__py3-none-any.whl

custom_python_logger/logger.py

@@ -2,9 +2,10 @@ import json
 import logging
 import os
 import time
+from collections.abc import Callable
 from logging import Logger
 from pathlib import Path
-from typing import Any, Callable, Optional
+from typing import Any
 
 import yaml
 from colorlog import ColoredFormatter
@@ -12,21 +13,15 @@ from colorlog import ColoredFormatter
 from custom_python_logger.consts import LOG_COLORS, CustomLoggerLevel
 
 
-def json_pretty_format(
-    data: Any, indent: int = 4, sort_keys: bool = True, default: Callable = None
-) -> str:
+def json_pretty_format(data: Any, indent: int = 4, sort_keys: bool = True, default: Callable = None) -> str:
     return json.dumps(data, indent=indent, sort_keys=sort_keys, default=default)
 
 
-def yaml_pretty_format(
-    data: Any, indent: int = 4, sort_keys: bool = False, allow_unicode=True
-) -> str:
-    return yaml.dump(
-        data, sort_keys=sort_keys, indent=indent, allow_unicode=allow_unicode
-    )
+def yaml_pretty_format(data: Any, indent: int = 4, sort_keys: bool = False, allow_unicode: bool = True) -> str:
+    return yaml.dump(data, sort_keys=sort_keys, indent=indent, allow_unicode=allow_unicode)
 
 
-def get_project_path_by_file(markers: Optional[list[str]] = None) -> Path:
+def get_project_path_by_file(markers: list[str] | None = None) -> Path:
     if not markers:
         markers = ["pyproject.toml", "setup.py", ".git", "requirements.txt", ".gitignore", ".github", ".gitlab"]
     path = Path(__file__).resolve() if "__file__" in globals() else Path.cwd().resolve()
@@ -53,12 +48,12 @@ def print_before_logger(project_name: str) -> None:
 
 
 class CustomLoggerAdapter(logging.LoggerAdapter):
-    def exception(self, msg: str, *args, **kwargs):
+    def exception(self, msg: str, *args: Any, **kwargs: Any) -> None:
         logging.addLevelName(CustomLoggerLevel.EXCEPTION.value, "EXCEPTION")
         kwargs.setdefault("stacklevel", 2)
         self.log(CustomLoggerLevel.EXCEPTION.value, msg, *args, exc_info=True, **kwargs)
 
-    def step(self, msg: str, *args, **kwargs):
+    def step(self, msg: str, *args: Any, **kwargs: Any) -> None:
         logging.addLevelName(CustomLoggerLevel.STEP.value, "STEP")
         kwargs.setdefault("stacklevel", 2)
         self.log(CustomLoggerLevel.STEP.value, msg, *args, exc_info=False, **kwargs)
@@ -72,7 +67,7 @@ def clear_existing_handlers(logger: Logger) -> None:
 def add_file_handler_if_specified(
     logger: Logger,
     log_file: bool,
-    log_file_path: Optional[str],
+    log_file_path: str | None,
     log_format: str,
 ) -> None:
     if log_file and log_file_path is not None:
@@ -89,11 +84,7 @@ def add_file_handler_if_specified(
         logger.addHandler(file_handler)
 
 
-def add_console_handler_if_specified(
-    logger: Logger,
-    console_output: bool,
-    log_format: str
-):
+def add_console_handler_if_specified(logger: Logger, console_output: bool, log_format: str) -> None:
     if console_output:
         log_console_formatter = ColoredFormatter(
             "%(log_color)s " + log_format,
@@ -110,7 +101,7 @@ def configure_logging(
     utc: bool,
     log_level: int = logging.INFO,
     log_file: bool = False,
-    log_file_path: Optional[str] = None,
+    log_file_path: str | None = None,
     console_output: bool = True,
 ) -> None:
     """
@@ -148,8 +139,8 @@ def configure_logging(
 
 def build_logger(
     project_name: str,
-    extra: Optional[dict[str, Any]] = None,
-    log_format: str = "%(asctime)s | %(levelname)-9s | l.%(levelno)s | %(name)s | %(filename)s:%(lineno)s | %(message)s",
+    extra: dict[str, Any] | None = None,
+    log_format: str = "%(asctime)s | %(levelname)-9s | l.%(levelno)s | %(name)s | %(filename)s:%(lineno)s | %(message)s",  # pylint: disable=C0301
     log_level: int = logging.INFO,
     log_file: bool = False,
     log_file_path: str = None,
@@ -192,5 +183,5 @@ def build_logger(
     return CustomLoggerAdapter(logger, extra)
 
 
-def get_logger(name: str, extra: Optional[dict] = None) -> CustomLoggerAdapter:
+def get_logger(name: str, extra: dict | None = None) -> CustomLoggerAdapter:
     return CustomLoggerAdapter(logging.getLogger(name), extra=extra)

custom_python_logger/usage_example.py

@@ -4,16 +4,16 @@ from custom_python_logger import build_logger, get_logger
 
 
 class LoggerTest:
-    def __init__(self):
+    def __init__(self) -> None:
         self.logger = get_logger(self.__class__.__name__, extra={"class": self.__class__.__name__})
 
-    def main(self):
+    def main(self) -> None:
         self.logger.debug("Hello World")
         self.logger.info("Hello World")
         self.logger.step("Hello World")
 
 
-def main():
+def main() -> None:
     logger = build_logger(
         project_name="Logger Project Test",
         log_level=logging.DEBUG,

{custom_python_logger-2.0.3.dist-info → custom_python_logger-2.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: custom-python-logger
-Version: 2.0.3
+Version: 2.0.4
 Summary: A custom logger with color support and additional features.
 Home-page: https://github.com/aviz92/custom-python-logger
 Author: Avi Zaguri
@@ -12,6 +12,8 @@ License-File: LICENSE
 Requires-Dist: setuptools
 Requires-Dist: wheel
 Requires-Dist: colorlog
+Requires-Dist: python-dotenv
+Requires-Dist: pre-commit
 Requires-Dist: pytest
 Requires-Dist: pathlib
 Requires-Dist: PyYAML

custom_python_logger-2.0.4.dist-info/RECORD

@@ -0,0 +1,9 @@
+custom_python_logger/__init__.py,sha256=ZikWW8-tWv5bbK5_DCeoemAQVg6yTEOTQu6SVZHait8,283
+custom_python_logger/consts.py,sha256=Vut58yw0VkNTNiZ74qgar_nI2WHouwX3CiCAcOuUhrc,286
+custom_python_logger/logger.py,sha256=lZOsLpO79C7_LjJVshze7O8fCtK4PnLItgQaGZnlBuk,6045
+custom_python_logger/usage_example.py,sha256=A_QExIoDWhLI6d3BENzYLjhahOVtgVYyXsFZOBXbrss,1014
+custom_python_logger-2.0.4.dist-info/licenses/LICENSE,sha256=cSikHY6SZFsPZSBizCDAJ0-Bjjzxt-JtX6TVbKxwimo,1067
+custom_python_logger-2.0.4.dist-info/METADATA,sha256=uk6XNMTAX7BRFLMDTQN0j6_bsEfkdUS0diAg8NSTnM8,4040
+custom_python_logger-2.0.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+custom_python_logger-2.0.4.dist-info/top_level.txt,sha256=lMihLuDQUTn0aSzzzbv9LZZTWTAap0IKpKabUHwOgks,21
+custom_python_logger-2.0.4.dist-info/RECORD,,

custom_python_logger-2.0.3.dist-info/RECORD

@@ -1,9 +0,0 @@
-custom_python_logger/__init__.py,sha256=ZikWW8-tWv5bbK5_DCeoemAQVg6yTEOTQu6SVZHait8,283
-custom_python_logger/consts.py,sha256=Vut58yw0VkNTNiZ74qgar_nI2WHouwX3CiCAcOuUhrc,286
-custom_python_logger/logger.py,sha256=HNgV1QVLf07nemsHhWqhBh8yvgR3G-OINrp7d0cphB4,6006
-custom_python_logger/usage_example.py,sha256=_-xur33-LXr2A91vkKNLrv0ON4k4uEsiZQK5-JxGIH4,990
-custom_python_logger-2.0.3.dist-info/licenses/LICENSE,sha256=cSikHY6SZFsPZSBizCDAJ0-Bjjzxt-JtX6TVbKxwimo,1067
-custom_python_logger-2.0.3.dist-info/METADATA,sha256=n4solp9EervNNvcJRtE03XTvfKd0Tqj0M0cwz0RT7WU,3985
-custom_python_logger-2.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-custom_python_logger-2.0.3.dist-info/top_level.txt,sha256=lMihLuDQUTn0aSzzzbv9LZZTWTAap0IKpKabUHwOgks,21
-custom_python_logger-2.0.3.dist-info/RECORD,,