custom-python-logger 2.0.14__tar.gz → 3.0.1__tar.gz

{custom_python_logger-2.0.14/custom_python_logger.egg-info → custom_python_logger-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: custom-python-logger
-Version: 2.0.14
+Version: 3.0.1
 Summary: A custom logger with color support and additional features.
 Author: Avi Zaguri
 License: MIT

{custom_python_logger-2.0.14 → custom_python_logger-3.0.1}/custom_python_logger/logger.py

@@ -15,7 +15,7 @@ from custom_python_logger.consts import LOG_COLORS, CustomLoggerLevel
 CUSTOM_LOGGER = "custom_logger"
 
 
-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 = None) -> str:
     return json.dumps(data, indent=indent, sort_keys=sort_keys, default=default)
 
 
@@ -38,14 +38,14 @@ def get_project_path_by_file(markers: set[str] | None = None) -> Path:
     raise RuntimeError(f'Project root with one of the markers: "{markers}" not found.')
 
 
-def print_before_logger(project_name: str) -> None:
+def print_before_logger(project_name: str, sleep_time: float = 0.3) -> None:
     main_string = f'Start "{project_name}" Process'
 
     number_of_ladder = "#" * len(f"### {main_string} ###")
     print(f"\n{number_of_ladder}")
     print(f"### {main_string} ###")
     print(f"{number_of_ladder}\n")
-    time.sleep(0.3)
+    time.sleep(sleep_time)
 
 
 class CustomLoggerAdapter(logging.LoggerAdapter):
@@ -59,17 +59,17 @@ class CustomLoggerAdapter(logging.LoggerAdapter):
         kwargs.setdefault("stacklevel", 2)
         self.log(CustomLoggerLevel.STEP.value, msg, *args, exc_info=False, **kwargs)
 
-    def success(self, msg: str, *args, **kwargs) -> None:
+    def success(self, msg: str, *args: Any, **kwargs: Any) -> None:
         logging.addLevelName(CustomLoggerLevel.SUCCESS.value, "SUCCESS")
         kwargs.setdefault("stacklevel", 2)
         self.log(CustomLoggerLevel.SUCCESS.value, msg, *args, **kwargs)
 
-    def alert(self, msg: str, *args, **kwargs) -> None:
+    def alert(self, msg: str, *args: Any, **kwargs: Any) -> None:
         logging.addLevelName(CustomLoggerLevel.ALERT.value, "ALERT")
         kwargs.setdefault("stacklevel", 2)
         self.log(CustomLoggerLevel.ALERT.value, msg, *args, **kwargs)
 
-    def trace(self, msg: str, *args, **kwargs) -> None:
+    def trace(self, msg: str, *args: Any, **kwargs: Any) -> None:
         logging.addLevelName(CustomLoggerLevel.TRACE.value, "TRACE")
         kwargs.setdefault("stacklevel", 2)
         self.log(CustomLoggerLevel.TRACE.value, msg, *args, **kwargs)
@@ -80,77 +80,27 @@ def clear_existing_handlers(logger: Logger) -> None:
         logger.removeHandler(handler)
 
 
-def add_file_handler_if_specified(
-    logger: Logger,
-    log_file: bool,
-    log_file_path: str | None,
-    log_format: str,
-) -> None:
-    if log_file and log_file_path is not None:
+def add_file_handler(logger: Logger, log_file_path: str | None, log_format: str) -> None:
+    if log_file_path is not None:
         log_file_formatter = logging.Formatter(log_format)
 
-        # Create directory if it doesn't exist
-        log_dir = os.path.dirname(log_file_path)
-        if log_dir and not os.path.exists(log_dir):
-            try:
-                os.makedirs(log_dir)
-            except FileExistsError:
-                pass  # Directory was created by another process            
+        if log_dir := os.path.dirname(log_file_path):
+            os.makedirs(log_dir, exist_ok=True)
 
         file_handler = logging.FileHandler(log_file_path)
-
         file_handler.setFormatter(log_file_formatter)
         logger.addHandler(file_handler)
 
 
-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,
-            log_colors=LOG_COLORS,
-        )
-
-        console_handler = logging.StreamHandler()
-        console_handler.setFormatter(log_console_formatter)
-        logger.addHandler(console_handler)
-
-
-def configure_logging(
-    log_format: str,
-    utc: bool,
-    log_file: bool = False,
-    log_file_path: str | None = None,
-    console_output: bool = True,
-) -> None:
-    """
-    Configure global logging settings.
-
-    Args:
-        log_format: Format string for log messages
-        utc: Whether to use UTC time for log timestamps
-        log_file: Whether to log to a file
-        log_file_path: Path to log file (if None, no file logging)
-        console_output: Whether to output logs to console
-    """
-    if utc:
-        logging.Formatter.converter = time.gmtime
-
-    root_logger = logging.getLogger()
-
-    clear_existing_handlers(logger=root_logger)
-
-    add_file_handler_if_specified(
-        logger=root_logger,
-        log_file=log_file,
-        log_file_path=log_file_path,
-        log_format=log_format,
+def add_console_handler(logger: Logger, log_format: str) -> None:
+    log_console_formatter = ColoredFormatter(
+        "%(log_color)s " + log_format,
+        log_colors=LOG_COLORS,
     )
 
-    add_console_handler_if_specified(
-        logger=root_logger,
-        console_output=console_output,
-        log_format=log_format,
-    )
+    console_handler = logging.StreamHandler()
+    console_handler.setFormatter(log_console_formatter)
+    logger.addHandler(console_handler)
 
 
 def get_logger(name: str, log_level: int | None = None, extra: dict | None = None) -> CustomLoggerAdapter:
@@ -165,18 +115,18 @@ def get_logger(name: str, log_level: int | None = None, extra: dict | None = Non
     return new_logger
 
 
-def build_logger(
+def build_logger(  # pylint: disable=R0913
     project_name: str,
     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.DEBUG,
     log_file: bool = False,
-    log_file_path: str = None,
+    log_file_path: str | None = None,
     console_output: bool = True,
     utc: bool = False,
-) -> CustomLoggerAdapter | Logger:
+) -> CustomLoggerAdapter:
     """
-    Get a named logger with optional extra context.
+    Configure global logging settings and get a named logger with optional extra context.
 
     Args:
         project_name: Name of the project
@@ -190,17 +140,22 @@ def build_logger(
     Returns:
         Configured logger
     """
-    if not log_file_path:
-        log_file_path = f"{get_project_path_by_file()}/logs/{project_name}.log"
-        log_file_path = log_file_path.lower().replace(" ", "_")
-
-    configure_logging(
-        log_format=log_format,
-        log_file=log_file,
-        log_file_path=log_file_path,
-        console_output=console_output,
-        utc=utc,
-    )
+
+    if utc:
+        logging.Formatter.converter = time.gmtime
+
+    root_logger = logging.getLogger()
+    clear_existing_handlers(logger=root_logger)
+
+    if console_output:
+        add_console_handler(logger=root_logger, log_format=log_format)
+
+    if log_file:
+        if not log_file_path:
+            log_file_path = f"{get_project_path_by_file()}/logs/{project_name}.log"
+            log_file_path = log_file_path.lower().replace(" ", "_")
+        add_file_handler(logger=root_logger, log_file_path=log_file_path, log_format=log_format)
+
     logger = CustomLoggerAdapter(logging.getLogger(CUSTOM_LOGGER), extra)
     logger.setLevel(log_level)
 

{custom_python_logger-2.0.14 → custom_python_logger-3.0.1/custom_python_logger.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: custom-python-logger
-Version: 2.0.14
+Version: 3.0.1
 Summary: A custom logger with color support and additional features.
 Author: Avi Zaguri
 License: MIT

{custom_python_logger-2.0.14 → custom_python_logger-3.0.1}/custom_python_logger.egg-info/SOURCES.txt

@@ -2,7 +2,6 @@ LICENSE
 MANIFEST.in
 README.md
 pyproject.toml
-requirements.txt
 custom_python_logger/__init__.py
 custom_python_logger/consts.py
 custom_python_logger/logger.py

{custom_python_logger-2.0.14 → custom_python_logger-3.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "custom-python-logger"
-version = "2.0.14"
+version = "3.0.1"
 description = "A custom logger with color support and additional features."
 readme = "README.md"
 requires-python = ">=3.12"

{custom_python_logger-2.0.14 → custom_python_logger-3.0.1}/tests/test_logger.py

@@ -4,17 +4,17 @@ from custom_python_logger import build_logger
 
 
 class TestLogger(unittest.TestCase):
-    def test_logger_creation(self):
+    def test_logger_creation(self) -> None:
         logger = build_logger(project_name="TestProject")
         self.assertIsNotNone(logger)
-        self.assertEqual(logger.name, "root")
+        self.assertEqual(logger.name, "custom_logger.TestProject")
 
-    def test_step_log(self):
+    def test_step_log(self) -> None:
         logger = build_logger(project_name="TestProject")
         logger.step("Testing step log")
         self.assertTrue(True)  # pylint: disable=W1503
 
-    def test_exception_log(self):
+    def test_exception_log(self) -> None:
         logger = build_logger(project_name="TestProject")
         try:
             raise ValueError("Test exception")

{custom_python_logger-2.0.14 → custom_python_logger-3.0.1}/tests/test_logger_pytest.py

@@ -3,6 +3,7 @@ import logging
 import os
 import tempfile
 import time
+from collections.abc import Generator
 
 import pytest
 
@@ -10,13 +11,13 @@ from custom_python_logger import CustomLoggerAdapter, build_logger, json_pretty_
 
 
 @pytest.fixture
-def temp_log_file():
+def temp_log_file() -> Generator[str, None, None]:
     with tempfile.NamedTemporaryFile(delete=False) as f:
         yield f.name
     os.remove(f.name)
 
 
-def test_logger_creation():
+def test_logger_creation() -> None:
     logger = build_logger(project_name="PytestTest")
     assert logger is not None
     assert isinstance(logger, CustomLoggerAdapter)
@@ -24,7 +25,7 @@ def test_logger_creation():
     assert hasattr(logger, "exception")
 
 
-def test_step_log(caplog):
+def test_step_log(caplog: pytest.LogCaptureFixture) -> None:
     logger = build_logger(project_name="PytestTest", console_output=False)
     if not isinstance(logger, CustomLoggerAdapter):
         raise AssertionError("Logger is not a CustomLoggerAdapter")
@@ -36,7 +37,7 @@ def test_step_log(caplog):
     assert any("STEP" in r.levelname for r in caplog.records)
 
 
-def test_step_log_2(caplog):
+def test_step_log_2(caplog: pytest.LogCaptureFixture) -> None:
     logger = build_logger(project_name="TestProject", console_output=False)
     if not isinstance(logger, CustomLoggerAdapter):
         raise AssertionError("Logger is not a CustomLoggerAdapter")
@@ -47,7 +48,7 @@ def test_step_log_2(caplog):
     assert any("STEP" in r.levelname for r in caplog.records)
 
 
-def test_exception_log(caplog):
+def test_exception_log(caplog: pytest.LogCaptureFixture) -> None:
     logger = build_logger(project_name="PytestTest", console_output=False)
     logging.getLogger().addHandler(caplog.handler)
     with caplog.at_level(logging.ERROR):
@@ -59,7 +60,7 @@ def test_exception_log(caplog):
     assert any("EXCEPTION" in r.levelname for r in caplog.records)
 
 
-def test_exception_log_2(caplog):
+def test_exception_log_2(caplog: pytest.LogCaptureFixture) -> None:
     logger = build_logger(project_name="TestProject", console_output=False)
     logging.getLogger().addHandler(caplog.handler)
     with caplog.at_level(logging.ERROR):
@@ -71,7 +72,7 @@ def test_exception_log_2(caplog):
     assert any("EXCEPTION" in r.levelname for r in caplog.records)
 
 
-def test_log_to_file(temp_log_file):  # pylint: disable=W0621
+def test_log_to_file(temp_log_file: str) -> None:  # pylint: disable=W0621
     logger = build_logger(project_name="FileTest", log_file=True, log_file_path=temp_log_file)
     logger.info("File log message")
     time.sleep(0.1)
@@ -80,7 +81,7 @@ def test_log_to_file(temp_log_file):  # pylint: disable=W0621
     assert "File log message" in content
 
 
-def test_utc_logging(temp_log_file):  # pylint: disable=W0621
+def test_utc_logging(temp_log_file: str) -> None:  # pylint: disable=W0621
     logger = build_logger(project_name="UTCTest", log_file=True, log_file_path=temp_log_file, utc=True)
     logger.info("UTC log message")
     time.sleep(0.1)
@@ -92,7 +93,7 @@ def test_utc_logging(temp_log_file):  # pylint: disable=W0621
     assert now_utc in content
 
 
-def test_extra_context(caplog):
+def test_extra_context(caplog: pytest.LogCaptureFixture) -> None:
     logger = build_logger(project_name="ExtraTest", extra={"user": "pytest"}, console_output=False)
     logging.getLogger().addHandler(caplog.handler)
     with caplog.at_level(logging.INFO):
@@ -101,13 +102,13 @@ def test_extra_context(caplog):
     # The extra field is not in the default format, but test that logger works with extra
 
 
-def test_json_pretty_format():
+def test_json_pretty_format() -> None:
     data = {"a": 1, "b": 2}
     result = json_pretty_format(data)
     assert "{" in result and "a" in result and "b" in result
 
 
-def test_yaml_pretty_format():
+def test_yaml_pretty_format() -> None:
     data = {"a": 1, "b": 2}
     result = yaml_pretty_format(data)
     assert "a:" in result and "b:" in result

{custom_python_logger-2.0.14 → custom_python_logger-3.0.1}/tests/test_usage_example_pytest.py

@@ -1,7 +1,9 @@
+import pytest
+
 from usage_example.example_1 import main
 
 
-def test_usage_example_runs(monkeypatch):
+def test_usage_example_runs(monkeypatch: pytest.MonkeyPatch) -> None:
     # Patch print and time.sleep to avoid side effects
     monkeypatch.setattr("builtins.print", lambda *a, **k: None)
     monkeypatch.setattr("time.sleep", lambda x: None)

custom_python_logger-2.0.14/requirements.txt

@@ -1,8 +0,0 @@
-setuptools
-wheel
-colorlog
-python-dotenv
-pre-commit
-pytest
-pathlib
-PyYAML