custom-python-logger 1.0.11__tar.gz → 2.0.0__tar.gz

{custom_python_logger-1.0.11/custom_python_logger.egg-info → custom_python_logger-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: custom-python-logger
-Version: 1.0.11
+Version: 2.0.0
 Summary: A custom logger with color support and additional features.
 Home-page: https://github.com/aviz92/custom-python-logger
 Author: Avi Zaguri
@@ -54,9 +54,9 @@ Here's a quick example of how to use `custom-python-logger` in your project:
 
 ```python
 import logging
-from custom_python_logger import get_logger, CustomLoggerAdapter
+from custom_python_logger import build_logger, CustomLoggerAdapter
 
-logger: CustomLoggerAdapter = get_logger(
+logger: CustomLoggerAdapter = build_logger(
     project_name='Logger Project Test',
     log_level=logging.DEBUG,
     log_file=True,
@@ -78,32 +78,46 @@ logger.critical("This is a critical message.")
 #### Advanced Usage
 - Log to a file:
   ```python
-  from custom_python_logger import get_logger, CustomLoggerAdapter
+  from custom_python_logger import build_logger
 
-  logger = get_logger(project_name='MyApp', log_file=True)
+  logger = build_logger(project_name='MyApp', log_file=True)
   ```
+
 - Use UTC timestamps:
   ```python
-  from custom_python_logger import get_logger, CustomLoggerAdapter
+  from custom_python_logger import build_logger
 
-  logger = get_logger(project_name='MyApp', log_file=True, utc=True)
+  logger = build_logger(project_name='MyApp', log_file=True, utc=True)
   ```
+
 - Add extra context:
   ```python
-  from custom_python_logger import get_logger, CustomLoggerAdapter
+  from custom_python_logger import build_logger
 
-  logger = get_logger(project_name='MyApp', log_file=True, utc=True, extra={'user': 'alice'})
+  logger = build_logger(project_name='MyApp', log_file=True, utc=True, extra={'user': 'alice'})
   ```
+
 - Pretty-print JSON or YAML:
   ```python
-  from custom_python_logger import get_logger, CustomLoggerAdapter, json_pretty_format, yaml_pretty_format
+  from custom_python_logger import build_logger, json_pretty_format, yaml_pretty_format
 
-  logger = get_logger(project_name='MyApp', utc=True, log_file=True)
+  logger = build_logger(project_name='MyApp', utc=True, log_file=True)
 
   logger.info(json_pretty_format({'foo': 'bar'}))
   logger.info(yaml_pretty_format({'foo': 'bar'}))
   ```
 
+- use an existing logger (CustomLoggerAdapter) and set a custom name:
+  ```python
+  from custom_python_logger import get_logger
+
+  logger = get_logger('some-name')
+
+logger.debug("This is a debug message.")
+logger.info("This is an info message.")
+logger.step("This is a step message.")
+  ```
+
 ---
 
 ## 🤝 Contributing

{custom_python_logger-1.0.11 → custom_python_logger-2.0.0}/README.md

@@ -27,9 +27,9 @@ Here's a quick example of how to use `custom-python-logger` in your project:
 
 ```python
 import logging
-from custom_python_logger import get_logger, CustomLoggerAdapter
+from custom_python_logger import build_logger, CustomLoggerAdapter
 
-logger: CustomLoggerAdapter = get_logger(
+logger: CustomLoggerAdapter = build_logger(
     project_name='Logger Project Test',
     log_level=logging.DEBUG,
     log_file=True,
@@ -51,32 +51,46 @@ logger.critical("This is a critical message.")
 #### Advanced Usage
 - Log to a file:
   ```python
-  from custom_python_logger import get_logger, CustomLoggerAdapter
+  from custom_python_logger import build_logger
 
-  logger = get_logger(project_name='MyApp', log_file=True)
+  logger = build_logger(project_name='MyApp', log_file=True)
   ```
+
 - Use UTC timestamps:
   ```python
-  from custom_python_logger import get_logger, CustomLoggerAdapter
+  from custom_python_logger import build_logger
 
-  logger = get_logger(project_name='MyApp', log_file=True, utc=True)
+  logger = build_logger(project_name='MyApp', log_file=True, utc=True)
   ```
+
 - Add extra context:
   ```python
-  from custom_python_logger import get_logger, CustomLoggerAdapter
+  from custom_python_logger import build_logger
 
-  logger = get_logger(project_name='MyApp', log_file=True, utc=True, extra={'user': 'alice'})
+  logger = build_logger(project_name='MyApp', log_file=True, utc=True, extra={'user': 'alice'})
   ```
+
 - Pretty-print JSON or YAML:
   ```python
-  from custom_python_logger import get_logger, CustomLoggerAdapter, json_pretty_format, yaml_pretty_format
+  from custom_python_logger import build_logger, json_pretty_format, yaml_pretty_format
 
-  logger = get_logger(project_name='MyApp', utc=True, log_file=True)
+  logger = build_logger(project_name='MyApp', utc=True, log_file=True)
 
   logger.info(json_pretty_format({'foo': 'bar'}))
   logger.info(yaml_pretty_format({'foo': 'bar'}))
   ```
 
+- use an existing logger (CustomLoggerAdapter) and set a custom name:
+  ```python
+  from custom_python_logger import get_logger
+
+  logger = get_logger('some-name')
+
+logger.debug("This is a debug message.")
+logger.info("This is an info message.")
+logger.step("This is a step message.")
+  ```
+
 ---
 
 ## 🤝 Contributing

custom_python_logger-2.0.0/custom_python_logger/__init__.py

@@ -0,0 +1,15 @@
+from custom_python_logger.logger import (
+    CustomLoggerAdapter,
+    build_logger,
+    get_logger,
+    json_pretty_format,
+    yaml_pretty_format,
+)
+
+__all__ = [
+    "build_logger",
+    "get_logger",
+    "CustomLoggerAdapter",
+    "json_pretty_format",
+    "yaml_pretty_format",
+]

{custom_python_logger-1.0.11 → custom_python_logger-2.0.0}/custom_python_logger/logger.py

@@ -1,19 +1,21 @@
-# logger.py
 import json
 import logging
 import os
 import time
-from logging import LoggerAdapter, Logger
+from logging import Logger, LoggerAdapter
 from pathlib import Path
-from typing import Optional, Any
+from typing import Any, Callable, Optional
+
 import yaml
 from colorlog import ColoredFormatter
 
 
-def get_root_project_path() -> Path:
-    if 'venv' in str(Path(__file__)):
-        return Path(__file__).parents[5]
-    return Path(__file__).parent
+def get_project_path_by_file(marker: str = ".git") -> Path:
+    path = Path(__file__).resolve()
+    for parent in path.parents:
+        if (parent / marker).exists():
+            return parent
+    raise RuntimeError(f"Project root with marker '{marker}' not found.")
 
 
 def print_before_logger(project_name: str) -> None:
@@ -30,23 +32,23 @@ class CustomLoggerAdapter(logging.LoggerAdapter):
     def exception(self, msg: str, *args, **kwargs):
         level_no = 45
         logging.addLevelName(level_no, "EXCEPTION")
-        kwargs.setdefault('stacklevel', 2)
+        kwargs.setdefault("stacklevel", 2)
         self.log(level_no, msg, *args, exc_info=True, **kwargs)
 
     def step(self, msg: str, *args, **kwargs):
         level_no = 25
         logging.addLevelName(level_no, "STEP")
-        kwargs.setdefault('stacklevel', 2)
+        kwargs.setdefault("stacklevel", 2)
         self.log(level_no, msg, *args, exc_info=False, **kwargs)
 
 
 def configure_logging(
-        log_format: str,
-        utc: bool,
-        log_level: int = logging.INFO,
-        log_file: bool = False,
-        log_file_path: Optional[str] = None,
-        console_output: bool = True,
+    log_format: str,
+    utc: bool,
+    log_level: int = logging.INFO,
+    log_file: bool = False,
+    log_file_path: Optional[str] = None,
+    console_output: bool = True,
 ) -> None:
     """
     Configure global logging settings.
@@ -87,16 +89,16 @@ def configure_logging(
     if console_output:
         # log_console_formatter = logging.Formatter('%(log_color)s ' + log_format)
         log_console_formatter = ColoredFormatter(
-            '%(log_color)s ' + log_format,
+            "%(log_color)s " + log_format,
             log_colors={
-                'DEBUG': 'white',
-                'INFO': 'green',
-                'WARNING': 'yellow',
-                'STEP': 'blue',
-                'ERROR': 'red,bold',
-                'EXCEPTION': 'light_red,bold',
-                'CRITICAL': 'red,bg_white',
-            }
+                "DEBUG": "white",
+                "INFO": "green",
+                "WARNING": "yellow",
+                "STEP": "blue",
+                "ERROR": "red,bold",
+                "EXCEPTION": "light_red,bold",
+                "CRITICAL": "red,bg_white",
+            },
         )
 
         console_handler = logging.StreamHandler()
@@ -104,16 +106,16 @@ def configure_logging(
         root_logger.addHandler(console_handler)
 
 
-def get_logger(
-        project_name: str,
-        extra: Optional[dict[str, Any]] = None,
-        log_format: str = "%(asctime)s | %(levelname)-10s(l.%(levelno)s) | %(filename)s:%(lineno)s | %(message)s",
-        log_level: int = logging.INFO,
-        log_file: bool = False,
-        log_file_path: str = None,
-        console_output: bool = True,
-        utc: bool = False,
-) -> CustomLoggerAdapter[Logger | LoggerAdapter[Any] | Any] | Logger:
+def build_logger(
+    project_name: str,
+    extra: Optional[dict[str, Any]] = None,
+    log_format: str = "%(asctime)s | %(levelname)-10s(l.%(levelno)s) | %(name)s | %(filename)s:%(lineno)s | %(message)s",
+    log_level: int = logging.INFO,
+    log_file: bool = False,
+    log_file_path: str = None,
+    console_output: bool = True,
+    utc: bool = False,
+) -> CustomLoggerAdapter | Logger:
     """
     Get a named logger with optional extra context.
 
@@ -133,8 +135,8 @@ def get_logger(
     print_before_logger(project_name=project_name)
 
     if not log_file_path:
-        log_file_path = f'{get_root_project_path()}/logs/{project_name}.log'
-        log_file_path = log_file_path.lower().replace(' ', '_')
+        log_file_path = f"{get_project_path_by_file()}/logs/{project_name}.log"
+        log_file_path = log_file_path.lower().replace(" ", "_")
 
     configure_logging(
         log_level=logging.DEBUG,
@@ -142,7 +144,7 @@ def get_logger(
         log_file=log_file,
         log_file_path=log_file_path,
         console_output=console_output,
-        utc=utc
+        utc=utc,
     )
 
     logger = logging.getLogger()
@@ -153,19 +155,19 @@ def get_logger(
     return CustomLoggerAdapter(logger, extra)
 
 
+def get_logger(name: str) -> CustomLoggerAdapter:
+    return CustomLoggerAdapter(logging.getLogger(name), {})
+
+
 def json_pretty_format(
-        data: any,
-        indent: int = 4,
-        sort_keys: bool = True,
-        default: callable = None
+    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
+    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)
+    return yaml.dump(
+        data, sort_keys=sort_keys, indent=indent, allow_unicode=allow_unicode
+    )

{custom_python_logger-1.0.11 → custom_python_logger-2.0.0}/custom_python_logger/usage_example.py

@@ -1,19 +1,21 @@
 import logging
-from custom_python_logger import get_logger
+
+from custom_python_logger import build_logger, get_logger
 
 
 class LoggerTest:
     def __init__(self):
-        self.logger = logging.getLogger(self.__class__.__name__)
+        self.logger = get_logger(self.__class__.__name__)
 
     def main(self):
-        self.logger.info('Hello World')
-        self.logger.debug('Hello World')
+        self.logger.debug("Hello World")
+        self.logger.info("Hello World")
+        self.logger.step("Hello World")
 
 
 def main():
-    logger = get_logger(
-        project_name='Logger Project Test',
+    logger = build_logger(
+        project_name="Logger Project Test",
         log_level=logging.DEBUG,
         log_file=True,
         # extra={'user': 'test_user'}
@@ -35,5 +37,5 @@ def main():
     logger_test.main()
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

{custom_python_logger-1.0.11 → custom_python_logger-2.0.0/custom_python_logger.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: custom-python-logger
-Version: 1.0.11
+Version: 2.0.0
 Summary: A custom logger with color support and additional features.
 Home-page: https://github.com/aviz92/custom-python-logger
 Author: Avi Zaguri
@@ -54,9 +54,9 @@ Here's a quick example of how to use `custom-python-logger` in your project:
 
 ```python
 import logging
-from custom_python_logger import get_logger, CustomLoggerAdapter
+from custom_python_logger import build_logger, CustomLoggerAdapter
 
-logger: CustomLoggerAdapter = get_logger(
+logger: CustomLoggerAdapter = build_logger(
     project_name='Logger Project Test',
     log_level=logging.DEBUG,
     log_file=True,
@@ -78,32 +78,46 @@ logger.critical("This is a critical message.")
 #### Advanced Usage
 - Log to a file:
   ```python
-  from custom_python_logger import get_logger, CustomLoggerAdapter
+  from custom_python_logger import build_logger
 
-  logger = get_logger(project_name='MyApp', log_file=True)
+  logger = build_logger(project_name='MyApp', log_file=True)
   ```
+
 - Use UTC timestamps:
   ```python
-  from custom_python_logger import get_logger, CustomLoggerAdapter
+  from custom_python_logger import build_logger
 
-  logger = get_logger(project_name='MyApp', log_file=True, utc=True)
+  logger = build_logger(project_name='MyApp', log_file=True, utc=True)
   ```
+
 - Add extra context:
   ```python
-  from custom_python_logger import get_logger, CustomLoggerAdapter
+  from custom_python_logger import build_logger
 
-  logger = get_logger(project_name='MyApp', log_file=True, utc=True, extra={'user': 'alice'})
+  logger = build_logger(project_name='MyApp', log_file=True, utc=True, extra={'user': 'alice'})
   ```
+
 - Pretty-print JSON or YAML:
   ```python
-  from custom_python_logger import get_logger, CustomLoggerAdapter, json_pretty_format, yaml_pretty_format
+  from custom_python_logger import build_logger, json_pretty_format, yaml_pretty_format
 
-  logger = get_logger(project_name='MyApp', utc=True, log_file=True)
+  logger = build_logger(project_name='MyApp', utc=True, log_file=True)
 
   logger.info(json_pretty_format({'foo': 'bar'}))
   logger.info(yaml_pretty_format({'foo': 'bar'}))
   ```
 
+- use an existing logger (CustomLoggerAdapter) and set a custom name:
+  ```python
+  from custom_python_logger import get_logger
+
+  logger = get_logger('some-name')
+
+logger.debug("This is a debug message.")
+logger.info("This is an info message.")
+logger.step("This is a step message.")
+  ```
+
 ---
 
 ## 🤝 Contributing

{custom_python_logger-1.0.11 → custom_python_logger-2.0.0}/custom_python_logger.egg-info/SOURCES.txt

@@ -12,4 +12,6 @@ custom_python_logger.egg-info/SOURCES.txt
 custom_python_logger.egg-info/dependency_links.txt
 custom_python_logger.egg-info/requires.txt
 custom_python_logger.egg-info/top_level.txt
-tests/test_logger.py
+tests/test_logger.py
+tests/test_logger_pytest.py
+tests/test_usage_example_pytest.py

{custom_python_logger-1.0.11 → custom_python_logger-2.0.0}/setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-package_version = '1.0.11'
+package_version = '2.0.0'
 
 package_name = 'custom-python-logger'
 package_description = 'A custom logger with color support and additional features.'

{custom_python_logger-1.0.11 → custom_python_logger-2.0.0}/tests/test_logger.py

@@ -1,20 +1,20 @@
 import unittest
-from custom_python_logger import get_logger
+from custom_python_logger import build_logger
 
 
 class TestLogger(unittest.TestCase):
     def test_logger_creation(self):
-        logger = get_logger(project_name='TestProject')
+        logger = build_logger(project_name='TestProject')
         self.assertIsNotNone(logger)
         self.assertEqual(logger.name, 'root')
 
     def test_step_log(self):
-        logger = get_logger(project_name='TestProject')
+        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 = get_logger(project_name='TestProject')
+        logger = build_logger(project_name='TestProject')
         try:
             raise ValueError("Test exception")
         except ValueError as e:

custom_python_logger-2.0.0/tests/test_logger_pytest.py

@@ -0,0 +1,126 @@
+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,
+)
+
+
+@pytest.fixture
+def temp_log_file():
+    with tempfile.NamedTemporaryFile(delete=False) as f:
+        yield f.name
+    os.remove(f.name)
+
+
+def test_logger_creation():
+    logger = build_logger(project_name="PytestTest")
+    assert logger is not None
+    assert isinstance(logger, CustomLoggerAdapter)
+    assert hasattr(logger, "step")
+    assert hasattr(logger, "exception")
+
+
+def test_step_log(caplog):
+    logger = build_logger(project_name="PytestTest", console_output=False)
+    if not isinstance(logger, CustomLoggerAdapter):
+        raise AssertionError("Logger is not a CustomLoggerAdapter")
+    # Attach caplog.handler
+    logging.getLogger().addHandler(caplog.handler)
+    with caplog.at_level(logging.INFO):
+        logger.step("Step message")
+    assert any("Step message" in m for m in caplog.messages)
+    assert any("STEP" in r.levelname for r in caplog.records)
+
+
+def test_step_log_2(caplog):
+    logger = build_logger(project_name="TestProject", console_output=False)
+    if not isinstance(logger, CustomLoggerAdapter):
+        raise AssertionError("Logger is not a CustomLoggerAdapter")
+    logging.getLogger().addHandler(caplog.handler)
+    with caplog.at_level(logging.INFO):
+        logger.step("Testing step log")
+    assert any("Testing step log" in m for m in caplog.messages)
+    assert any("STEP" in r.levelname for r in caplog.records)
+
+
+def test_exception_log(caplog):
+    logger = build_logger(project_name="PytestTest", console_output=False)
+    logging.getLogger().addHandler(caplog.handler)
+    with caplog.at_level(logging.ERROR):
+        try:
+            raise RuntimeError("fail")
+        except RuntimeError:
+            logger.exception("Exception message")
+    assert any("Exception message" in m for m in caplog.messages)
+    assert any("EXCEPTION" in r.levelname for r in caplog.records)
+
+
+def test_exception_log_2(caplog):
+    logger = build_logger(project_name="TestProject", console_output=False)
+    logging.getLogger().addHandler(caplog.handler)
+    with caplog.at_level(logging.ERROR):
+        try:
+            raise ValueError("Test exception")
+        except ValueError as e:
+            logger.exception(f"Exception occurred: {e}")
+    assert any("Exception occurred: Test exception" in m for m in caplog.messages)
+    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
+    )
+    logger.info("File log message")
+    time.sleep(0.1)
+    with open(temp_log_file) as f:
+        content = f.read()
+    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
+    )
+    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")
+    assert now_utc in content
+
+
+def test_extra_context(caplog):
+    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")
+    assert any("With extra" in m for m in caplog.messages)
+    # The extra field is not in the default format, but test that logger works with extra
+
+
+def test_json_pretty_format():
+    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():
+    data = {"a": 1, "b": 2}
+    result = yaml_pretty_format(data)
+    assert "a:" in result and "b:" in result

custom_python_logger-2.0.0/tests/test_usage_example_pytest.py

@@ -0,0 +1,8 @@
+from custom_python_logger.usage_example import main
+
+
+def test_usage_example_runs(monkeypatch):
+    # Patch print and time.sleep to avoid side effects
+    monkeypatch.setattr("builtins.print", lambda *a, **k: None)
+    monkeypatch.setattr("time.sleep", lambda x: None)
+    main()  # Should not raise

custom_python_logger-1.0.11/custom_python_logger/__init__.py

@@ -1,10 +0,0 @@
-from custom_python_logger.logger import (
-    get_logger, CustomLoggerAdapter, json_pretty_format, yaml_pretty_format
-)
-
-__all__ = [
-    "get_logger",
-    "CustomLoggerAdapter",
-    "json_pretty_format",
-    "yaml_pretty_format"
-]