custom-python-logger 2.0.3__tar.gz → 2.0.4__tar.gz

{custom_python_logger-2.0.3/custom_python_logger.egg-info → custom_python_logger-2.0.4}/PKG-INFO

@@ -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.3 → custom_python_logger-2.0.4}/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-2.0.3 → custom_python_logger-2.0.4}/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 → custom_python_logger-2.0.4/custom_python_logger.egg-info}/PKG-INFO

@@ -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.3 → custom_python_logger-2.0.4}/custom_python_logger.egg-info/requires.txt

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

{custom_python_logger-2.0.3 → custom_python_logger-2.0.4}/requirements.txt

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

custom_python_logger-2.0.4/setup.py

@@ -0,0 +1,35 @@
+from setuptools import find_packages, setup
+
+package_version = "2.0.4"
+
+package_name = "custom-python-logger"
+package_description = "A custom logger with color support and additional features."
+
+package_name_ = package_name.replace("-", "_")
+package_long_description_content_type = "text/markdown"
+package_url = f"https://github.com/aviz92/{package_name}"
+package_python_requires = ">=3.11"
+package_author = "Avi Zaguri"
+
+with open("requirements.txt") as file:
+    package_install_requires = [line.strip() for line in file.readlines() if line.strip() and not line.startswith("#")]
+
+with open("README.md") as file:
+    package_long_description = file.read()
+
+setup(
+    name=package_name,
+    version=package_version,
+    packages=find_packages(include=[package_name_, f"{package_name_}.*"]),
+    install_requires=package_install_requires,
+    author=package_author,
+    author_email="",
+    description=package_description,
+    long_description=package_long_description,
+    long_description_content_type=package_long_description_content_type,
+    url=package_url,
+    project_urls={
+        "Repository": package_url,
+    },
+    python_requires=package_python_requires,
+)

custom_python_logger-2.0.4/tests/test_logger.py

@@ -0,0 +1,27 @@
+import unittest
+
+from custom_python_logger import build_logger
+
+
+class TestLogger(unittest.TestCase):
+    def test_logger_creation(self):
+        logger = build_logger(project_name="TestProject")
+        self.assertIsNotNone(logger)
+        self.assertEqual(logger.name, "root")
+
+    def test_step_log(self):
+        logger = build_logger(project_name="TestProject")
+        logger.step("Testing step log")
+        self.assertTrue(True)  # pylint: disable=W1503
+
+    def test_exception_log(self):
+        logger = build_logger(project_name="TestProject")
+        try:
+            raise ValueError("Test exception")
+        except ValueError as e:
+            logger.exception(f"Exception occurred: {e}")
+        self.assertTrue(True)  # pylint: disable=W1503
+
+
+if __name__ == "__main__":
+    unittest.main()

{custom_python_logger-2.0.3 → custom_python_logger-2.0.4}/tests/test_logger_pytest.py

@@ -1,17 +1,12 @@
+import datetime
 import logging
 import os
 import tempfile
 import time
-from datetime import timezone
 
 import pytest
 
-from custom_python_logger import (
-    CustomLoggerAdapter,
-    build_logger,
-    json_pretty_format,
-    yaml_pretty_format,
-)
+from custom_python_logger import CustomLoggerAdapter, build_logger, json_pretty_format, yaml_pretty_format
 
 
 @pytest.fixture
@@ -76,10 +71,8 @@ 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):
-    logger = build_logger(
-        project_name="FileTest", log_file=True, log_file_path=temp_log_file
-    )
+def test_log_to_file(temp_log_file):  # 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)
     with open(temp_log_file) as f:
@@ -87,26 +80,20 @@ def test_log_to_file(temp_log_file):
     assert "File log message" in content
 
 
-def test_utc_logging(temp_log_file):
-    logger = build_logger(
-        project_name="UTCTest", log_file=True, log_file_path=temp_log_file, utc=True
-    )
+def test_utc_logging(temp_log_file):  # 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)
     with open(temp_log_file) as f:
         content = f.read()
     assert "UTC log message" in content
     # Check for a year in UTC (should be close to now)
-    import datetime
-
-    now_utc = datetime.datetime.now(tz=timezone.utc).strftime("%Y")
+    now_utc = datetime.datetime.now(tz=datetime.UTC).strftime("%Y")
     assert now_utc in content
 
 
 def test_extra_context(caplog):
-    logger = build_logger(
-        project_name="ExtraTest", extra={"user": "pytest"}, console_output=False
-    )
+    logger = build_logger(project_name="ExtraTest", extra={"user": "pytest"}, console_output=False)
     logging.getLogger().addHandler(caplog.handler)
     with caplog.at_level(logging.INFO):
         logger.info("With extra")

custom_python_logger-2.0.3/setup.py

@@ -1,37 +0,0 @@
-from setuptools import setup, find_packages
-
-package_version = '2.0.3'
-
-package_name = 'custom-python-logger'
-package_description = 'A custom logger with color support and additional features.'
-
-package_name_ = package_name.replace('-', '_')
-package_long_description_content_type = 'text/markdown'
-package_url = f'https://github.com/aviz92/{package_name}'
-package_python_requires = '>=3.11'
-package_author = 'Avi Zaguri'
-
-with open('requirements.txt', 'r') as file:
-    package_install_requires = [
-        line.strip() for line in file.readlines() if line.strip() and not line.startswith('#')
-    ]
-
-with open('README.md', 'r') as file:
-    package_long_description = file.read()
-
-setup(
-    name=package_name,
-    version=package_version,
-    packages=find_packages(include=[package_name_, f'{package_name_}.*']),
-    install_requires=package_install_requires,
-    author=package_author,
-    author_email='',
-    description=package_description,
-    long_description=package_long_description,
-    long_description_content_type=package_long_description_content_type,
-    url=package_url,
-    project_urls={
-        'Repository': package_url,
-    },
-    python_requires=package_python_requires,
-)

custom_python_logger-2.0.3/tests/test_logger.py

@@ -1,26 +0,0 @@
-import unittest
-from custom_python_logger import build_logger
-
-
-class TestLogger(unittest.TestCase):
-    def test_logger_creation(self):
-        logger = build_logger(project_name='TestProject')
-        self.assertIsNotNone(logger)
-        self.assertEqual(logger.name, 'root')
-
-    def test_step_log(self):
-        logger = build_logger(project_name='TestProject')
-        logger.step('Testing step log')
-        self.assertTrue(True)  # You can add more specific checks for actual logging output
-
-    def test_exception_log(self):
-        logger = build_logger(project_name='TestProject')
-        try:
-            raise ValueError("Test exception")
-        except ValueError as e:
-            logger.exception(f"Exception occurred: {e}")
-        self.assertTrue(True)  # You can add more specific checks for actual logging output
-
-
-if __name__ == '__main__':
-    unittest.main()