custom-python-logger 3.0.2__tar.gz → 4.0.1__tar.gz

{custom_python_logger-3.0.2/custom_python_logger.egg-info → custom_python_logger-4.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: custom-python-logger
-Version: 3.0.2
+Version: 4.0.1
 Summary: A custom logger with color support and additional features.
 Author: Avi Zaguri
 License: MIT
@@ -42,6 +42,7 @@ Easily integrate structured, readable, and context-rich logging into your Python
 - ✅ **Contextual Logging**: Add extra fields (like user, environment, etc.) to every log message.
 - ✅ **UTC Support**: Optionally log timestamps in UTC for consistency across environments.
 - ✅ **Pretty Formatting**: Built-in helpers for pretty-printing JSON and YAML data in logs.
+- ✅ **Short Path Display**: Automatically trims log file paths to project-relative or `.venv`-relative format for cleaner output.
 - ✅ **Easy Integration**: Simple API for getting a ready-to-use logger anywhere in your codebase.
 
 ---
@@ -80,6 +81,7 @@ logger.critical("This is a critical message.")
 ```
 
 #### Advanced Usage
+
 - Log to a file:
   ```python
   from custom_python_logger import build_logger
@@ -111,19 +113,62 @@ logger.critical("This is a critical message.")
   logger.info(yaml_pretty_format({'foo': 'bar'}))
   ```
 
-- use an existing logger (CustomLoggerAdapter) and set a custom name:
+- Use an existing logger with 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.")
+  logger.debug("This is a debug message.")
+  logger.info("This is an info message.")
+  logger.step("This is a step message.")
+  ```
+
+- Use a custom log format:
+  ```python
+  from custom_python_logger import build_logger, LOG_FORMAT_FILENAME, LOG_FORMAT_SHORTPATH
+
+  # Default — shows project-relative or .venv-relative path:
+  # 2026-05-18 | INFO      | l.20 | my_app | my_project/app/main.py:42 | message
+  logger = build_logger(project_name='MyApp', log_format=LOG_FORMAT_SHORTPATH)
+
+  # Classic — shows filename only (no path):
+  # 2026-05-18 | INFO      | l.20 | my_app | main.py:42 | message
+  logger = build_logger(project_name='MyApp', log_format=LOG_FORMAT_FILENAME)
   ```
 
 ---
 
+## 🗂️ Short Path Display
+
+By default, `build_logger` uses `LOG_FORMAT_SHORTPATH`, which trims the file path in every log line:
+
+| Path type | Raw `record.pathname` | Displayed as |
+|---|---|---|
+| Project file | `/home/user/my_project/app/main.py` | `my_project/app/main.py` |
+| Dependency in `.venv` | `/home/user/my_project/.venv/lib/python3.13/site-packages/urllib3/pool.py` | `.venv/lib/python3.13/site-packages/urllib3/pool.py` |
+| Unrecognised path | `/tmp/some_script.py` | `/tmp/some_script.py` (full path) |
+
+### Setting your project name
+
+The short-path logic uses the `PROJECT_NAME` environment variable to identify your project root.
+Set it in your `.env` file (loaded automatically on import) or export it before running:
+
+```bash
+# .env
+PROJECT_NAME=my_project
+```
+
+```bash
+# or inline
+PROJECT_NAME=my_project python main.py
+```
+
+> **Note:** `custom-python-logger` calls `load_dotenv()` on import, which reads your `.env` file automatically.
+> If you set `PROJECT_NAME` programmatically, do so **before** importing `custom_python_logger` to ensure it takes effect.
+
+---
+
 ## 🤝 Contributing
 If you have a helpful tool, pattern, or improvement to suggest:
 Fork the repo <br>

{custom_python_logger-3.0.2 → custom_python_logger-4.0.1}/README.md

@@ -20,6 +20,7 @@ Easily integrate structured, readable, and context-rich logging into your Python
 - ✅ **Contextual Logging**: Add extra fields (like user, environment, etc.) to every log message.
 - ✅ **UTC Support**: Optionally log timestamps in UTC for consistency across environments.
 - ✅ **Pretty Formatting**: Built-in helpers for pretty-printing JSON and YAML data in logs.
+- ✅ **Short Path Display**: Automatically trims log file paths to project-relative or `.venv`-relative format for cleaner output.
 - ✅ **Easy Integration**: Simple API for getting a ready-to-use logger anywhere in your codebase.
 
 ---
@@ -58,6 +59,7 @@ logger.critical("This is a critical message.")
 ```
 
 #### Advanced Usage
+
 - Log to a file:
   ```python
   from custom_python_logger import build_logger
@@ -89,19 +91,62 @@ logger.critical("This is a critical message.")
   logger.info(yaml_pretty_format({'foo': 'bar'}))
   ```
 
-- use an existing logger (CustomLoggerAdapter) and set a custom name:
+- Use an existing logger with 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.")
+  logger.debug("This is a debug message.")
+  logger.info("This is an info message.")
+  logger.step("This is a step message.")
+  ```
+
+- Use a custom log format:
+  ```python
+  from custom_python_logger import build_logger, LOG_FORMAT_FILENAME, LOG_FORMAT_SHORTPATH
+
+  # Default — shows project-relative or .venv-relative path:
+  # 2026-05-18 | INFO      | l.20 | my_app | my_project/app/main.py:42 | message
+  logger = build_logger(project_name='MyApp', log_format=LOG_FORMAT_SHORTPATH)
+
+  # Classic — shows filename only (no path):
+  # 2026-05-18 | INFO      | l.20 | my_app | main.py:42 | message
+  logger = build_logger(project_name='MyApp', log_format=LOG_FORMAT_FILENAME)
   ```
 
 ---
 
+## 🗂️ Short Path Display
+
+By default, `build_logger` uses `LOG_FORMAT_SHORTPATH`, which trims the file path in every log line:
+
+| Path type | Raw `record.pathname` | Displayed as |
+|---|---|---|
+| Project file | `/home/user/my_project/app/main.py` | `my_project/app/main.py` |
+| Dependency in `.venv` | `/home/user/my_project/.venv/lib/python3.13/site-packages/urllib3/pool.py` | `.venv/lib/python3.13/site-packages/urllib3/pool.py` |
+| Unrecognised path | `/tmp/some_script.py` | `/tmp/some_script.py` (full path) |
+
+### Setting your project name
+
+The short-path logic uses the `PROJECT_NAME` environment variable to identify your project root.
+Set it in your `.env` file (loaded automatically on import) or export it before running:
+
+```bash
+# .env
+PROJECT_NAME=my_project
+```
+
+```bash
+# or inline
+PROJECT_NAME=my_project python main.py
+```
+
+> **Note:** `custom-python-logger` calls `load_dotenv()` on import, which reads your `.env` file automatically.
+> If you set `PROJECT_NAME` programmatically, do so **before** importing `custom_python_logger` to ensure it takes effect.
+
+---
+
 ## 🤝 Contributing
 If you have a helpful tool, pattern, or improvement to suggest:
 Fork the repo <br>

{custom_python_logger-3.0.2 → custom_python_logger-4.0.1}/custom_python_logger/__init__.py

@@ -1,3 +1,6 @@
+from dotenv import load_dotenv
+
+from custom_python_logger.consts import LOG_FORMAT_FILENAME, LOG_FORMAT_SHORTPATH
 from custom_python_logger.logger import (
     CustomLoggerAdapter,
     CustomLoggerLevel,
@@ -7,6 +10,8 @@ from custom_python_logger.logger import (
     yaml_pretty_format,
 )
 
+load_dotenv()
+
 __all__ = [
     "CustomLoggerAdapter",
     "CustomLoggerLevel",
@@ -14,4 +19,6 @@ __all__ = [
     "get_logger",
     "json_pretty_format",
     "yaml_pretty_format",
+    "LOG_FORMAT_SHORTPATH",
+    "LOG_FORMAT_FILENAME",
 ]

{custom_python_logger-3.0.2 → custom_python_logger-4.0.1}/custom_python_logger/consts.py

@@ -1,5 +1,10 @@
 from enum import Enum
 
+LOG_FORMAT_FILENAME = "%(asctime)s | %(levelname)-9s | l.%(levelno)s | %(name)s | %(filename)s:%(lineno)s | %(message)s"
+LOG_FORMAT_SHORTPATH = (
+    "%(asctime)s | %(levelname)-9s | l.%(levelno)s | %(name)s | %(shortpath)s:%(lineno)s | %(message)s"
+)
+
 LOG_COLORS = {
     "DEBUG": "white",
     "INFO": "green",

{custom_python_logger-3.0.2 → custom_python_logger-4.0.1}/custom_python_logger/logger.py

@@ -10,7 +10,7 @@ from typing import Any
 import yaml
 from colorlog import ColoredFormatter
 
-from custom_python_logger.consts import LOG_COLORS, CustomLoggerLevel
+from custom_python_logger.consts import LOG_COLORS, LOG_FORMAT_FILENAME, CustomLoggerLevel
 
 CUSTOM_LOGGER = "custom_logger"
 
@@ -48,6 +48,30 @@ def print_before_logger(project_name: str, sleep_time: float = 0.3) -> None:
     time.sleep(sleep_time)
 
 
+class _ShortPathFilter(logging.Filter):
+    def __init__(self) -> None:
+        super().__init__()
+        self._project_name = os.getenv("PROJECT_NAME")
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        if self._project_name and self._project_name in record.pathname:
+            record.shortpath = self._project_name + record.pathname.rsplit(self._project_name, 1)[1]
+        else:
+            record.shortpath = record.pathname
+
+        if ".venv" in record.pathname:
+            record.shortpath = ".venv" + record.pathname.rsplit(".venv", 1)[1]
+        return True
+
+
+class _StripNamespaceFilter(logging.Filter):
+    def filter(self, record: logging.LogRecord) -> bool:
+        prefix = CUSTOM_LOGGER + "."
+        if record.name.startswith(prefix):
+            record.name = record.name[len(prefix) :]
+        return True
+
+
 class CustomLoggerAdapter(logging.LoggerAdapter):
     def exception(self, msg: str, *args: Any, **kwargs: Any) -> None:
         logging.addLevelName(CustomLoggerLevel.EXCEPTION.value, "EXCEPTION")
@@ -105,8 +129,11 @@ def add_console_handler(logger: Logger, log_format: str) -> None:
 
 def get_logger(name: str, log_level: int | None = None, extra: dict | None = None) -> CustomLoggerAdapter:
     custom_logger = logging.getLogger(CUSTOM_LOGGER)
+
     full_name = f"{CUSTOM_LOGGER}.{name}"
-    new_logger = CustomLoggerAdapter(logging.getLogger(full_name), extra=extra)
+    underlying = logging.getLogger(full_name)
+    underlying.addFilter(_StripNamespaceFilter())
+    new_logger = CustomLoggerAdapter(underlying, extra=extra)
 
     if log_level is None:
         log_level = custom_logger.level
@@ -118,7 +145,7 @@ def get_logger(name: str, log_level: int | None = None, extra: dict | None = Non
 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_format: str = LOG_FORMAT_FILENAME,
     log_level: int = logging.DEBUG,
     log_file: bool = False,
     log_file_path: str | None = None,
@@ -156,6 +183,9 @@ def build_logger(  # pylint: disable=R0913
             log_file_path = log_file_path.lower().replace(" ", "_")
         add_file_handler(logger=root_logger, log_file_path=log_file_path, log_format=log_format)
 
+    for handler in root_logger.handlers:
+        handler.addFilter(_ShortPathFilter())
+
     logger = CustomLoggerAdapter(logging.getLogger(CUSTOM_LOGGER), extra)
     logger.setLevel(log_level)
 

{custom_python_logger-3.0.2 → custom_python_logger-4.0.1/custom_python_logger.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: custom-python-logger
-Version: 3.0.2
+Version: 4.0.1
 Summary: A custom logger with color support and additional features.
 Author: Avi Zaguri
 License: MIT
@@ -42,6 +42,7 @@ Easily integrate structured, readable, and context-rich logging into your Python
 - ✅ **Contextual Logging**: Add extra fields (like user, environment, etc.) to every log message.
 - ✅ **UTC Support**: Optionally log timestamps in UTC for consistency across environments.
 - ✅ **Pretty Formatting**: Built-in helpers for pretty-printing JSON and YAML data in logs.
+- ✅ **Short Path Display**: Automatically trims log file paths to project-relative or `.venv`-relative format for cleaner output.
 - ✅ **Easy Integration**: Simple API for getting a ready-to-use logger anywhere in your codebase.
 
 ---
@@ -80,6 +81,7 @@ logger.critical("This is a critical message.")
 ```
 
 #### Advanced Usage
+
 - Log to a file:
   ```python
   from custom_python_logger import build_logger
@@ -111,19 +113,62 @@ logger.critical("This is a critical message.")
   logger.info(yaml_pretty_format({'foo': 'bar'}))
   ```
 
-- use an existing logger (CustomLoggerAdapter) and set a custom name:
+- Use an existing logger with 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.")
+  logger.debug("This is a debug message.")
+  logger.info("This is an info message.")
+  logger.step("This is a step message.")
+  ```
+
+- Use a custom log format:
+  ```python
+  from custom_python_logger import build_logger, LOG_FORMAT_FILENAME, LOG_FORMAT_SHORTPATH
+
+  # Default — shows project-relative or .venv-relative path:
+  # 2026-05-18 | INFO      | l.20 | my_app | my_project/app/main.py:42 | message
+  logger = build_logger(project_name='MyApp', log_format=LOG_FORMAT_SHORTPATH)
+
+  # Classic — shows filename only (no path):
+  # 2026-05-18 | INFO      | l.20 | my_app | main.py:42 | message
+  logger = build_logger(project_name='MyApp', log_format=LOG_FORMAT_FILENAME)
   ```
 
 ---
 
+## 🗂️ Short Path Display
+
+By default, `build_logger` uses `LOG_FORMAT_SHORTPATH`, which trims the file path in every log line:
+
+| Path type | Raw `record.pathname` | Displayed as |
+|---|---|---|
+| Project file | `/home/user/my_project/app/main.py` | `my_project/app/main.py` |
+| Dependency in `.venv` | `/home/user/my_project/.venv/lib/python3.13/site-packages/urllib3/pool.py` | `.venv/lib/python3.13/site-packages/urllib3/pool.py` |
+| Unrecognised path | `/tmp/some_script.py` | `/tmp/some_script.py` (full path) |
+
+### Setting your project name
+
+The short-path logic uses the `PROJECT_NAME` environment variable to identify your project root.
+Set it in your `.env` file (loaded automatically on import) or export it before running:
+
+```bash
+# .env
+PROJECT_NAME=my_project
+```
+
+```bash
+# or inline
+PROJECT_NAME=my_project python main.py
+```
+
+> **Note:** `custom-python-logger` calls `load_dotenv()` on import, which reads your `.env` file automatically.
+> If you set `PROJECT_NAME` programmatically, do so **before** importing `custom_python_logger` to ensure it takes effect.
+
+---
+
 ## 🤝 Contributing
 If you have a helpful tool, pattern, or improvement to suggest:
 Fork the repo <br>

{custom_python_logger-3.0.2 → custom_python_logger-4.0.1}/custom_python_logger.egg-info/SOURCES.txt

@@ -12,4 +12,5 @@ custom_python_logger.egg-info/requires.txt
 custom_python_logger.egg-info/top_level.txt
 tests/test_logger.py
 tests/test_logger_pytest.py
+tests/test_short_path_filter.py
 tests/test_usage_example_pytest.py

{custom_python_logger-3.0.2 → custom_python_logger-4.0.1}/pyproject.toml

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

custom_python_logger-4.0.1/tests/test_short_path_filter.py

@@ -0,0 +1,161 @@
+# pylint: disable=E1101  # LogRecord.shortpath is a dynamic attribute set by _ShortPathFilter
+import logging
+import os
+import tempfile
+from collections.abc import Generator
+from unittest.mock import patch
+
+import pytest
+
+from custom_python_logger import build_logger
+from custom_python_logger.logger import _ShortPathFilter
+
+
+def _make_record(pathname: str, name: str = "custom_logger.test") -> logging.LogRecord:
+    record = logging.LogRecord(
+        name=name,
+        level=logging.DEBUG,
+        pathname=pathname,
+        lineno=1,
+        msg="test",
+        args=(),
+        exc_info=None,
+    )
+    record.pathname = pathname
+    return record
+
+
+@pytest.fixture
+def temp_log_file() -> Generator[str, None, None]:  # pylint: disable=W0621
+    with tempfile.NamedTemporaryFile(delete=False, suffix=".log") as f:
+        yield f.name
+    os.remove(f.name)
+
+
+class TestShortPathFilterInit:
+    def test_caches_project_name_from_env(self) -> None:
+        with patch.dict(os.environ, {"PROJECT_NAME": "my_project"}):
+            f = _ShortPathFilter()
+        assert f._project_name == "my_project", f"Expected 'my_project', got {f._project_name}"  # pylint: disable=W0212
+
+    def test_project_name_none_when_env_not_set(self) -> None:
+        with patch.dict(os.environ, {}, clear=True):
+            f = _ShortPathFilter()
+        assert f._project_name is None, f"Expected None, got {f._project_name}"  # pylint: disable=W0212
+
+
+class TestShortPathFilterLogic:
+    def test_project_name_in_path_sets_relative_shortpath(self) -> None:
+        with patch.dict(os.environ, {"PROJECT_NAME": "my_project"}):
+            f = _ShortPathFilter()
+        record = _make_record("/home/user/my_project/app/main.py")
+
+        result = f.filter(record)
+
+        assert result is True, "filter() must always return True"
+        assert (
+            record.shortpath == "my_project/app/main.py"
+        ), (  # pylint: disable=E1101
+            f"Expected 'my_project/app/main.py', got '{record.shortpath}'"  # pylint: disable=E1101
+        )
+
+    def test_project_name_not_in_path_falls_back_to_full_pathname(self) -> None:
+        with patch.dict(os.environ, {"PROJECT_NAME": "my_project"}):
+            f = _ShortPathFilter()
+        record = _make_record("/home/user/other_project/app/main.py")
+
+        f.filter(record)
+
+        assert (
+            record.shortpath == "/home/user/other_project/app/main.py"
+        ), f"Expected full pathname, got '{record.shortpath}'"  # pylint: disable=E1101  # pylint: disable=E1101
+
+    def test_no_project_name_env_falls_back_to_full_pathname(self) -> None:
+        with patch.dict(os.environ, {}, clear=True):
+            f = _ShortPathFilter()
+        record = _make_record("/home/user/my_project/app/main.py")
+
+        f.filter(record)
+
+        assert (
+            record.shortpath == "/home/user/my_project/app/main.py"
+        ), f"Expected full pathname, got '{record.shortpath}'"  # pylint: disable=E1101  # pylint: disable=E1101
+
+    def test_venv_in_path_sets_venv_relative_shortpath(self) -> None:
+        with patch.dict(os.environ, {"PROJECT_NAME": "my_project"}):
+            f = _ShortPathFilter()
+        record = _make_record("/home/user/my_project/.venv/lib/python3.13/site-packages/urllib3/pool.py")
+
+        f.filter(record)
+
+        assert (
+            record.shortpath == ".venv/lib/python3.13/site-packages/urllib3/pool.py"
+        ), f"Expected .venv-relative path, got '{record.shortpath}'"  # pylint: disable=E1101  # pylint: disable=E1101
+
+    def test_venv_takes_precedence_over_project_name(self) -> None:
+        with patch.dict(os.environ, {"PROJECT_NAME": "my_project"}):
+            f = _ShortPathFilter()
+        record = _make_record("/home/user/my_project/.venv/lib/python3.13/site-packages/requests/api.py")
+
+        f.filter(record)
+
+        assert record.shortpath.startswith(
+            ".venv/"
+        ), f"Expected .venv-relative path, got '{record.shortpath}'"  # pylint: disable=E1101  # pylint: disable=E1101
+
+    def test_filter_always_returns_true(self) -> None:
+        with patch.dict(os.environ, {"PROJECT_NAME": "my_project"}):
+            f = _ShortPathFilter()
+
+        for pathname in (
+            "/some/random/path.py",
+            "/my_project/app.py",
+            "/.venv/lib/pkg.py",
+        ):
+            record = _make_record(pathname)
+            assert f.filter(record) is True, f"filter() returned False for '{pathname}'"
+
+    def test_shortpath_always_set_on_record(self) -> None:
+        with patch.dict(os.environ, {}, clear=True):
+            f = _ShortPathFilter()
+        record = _make_record("/any/path/file.py")
+
+        f.filter(record)
+
+        assert hasattr(record, "shortpath"), "shortpath attribute must always be set on the record"
+
+
+class TestBuildLoggerFilterIntegration:
+    def test_handler_has_short_path_filter_after_build(self) -> None:
+        root_logger = logging.getLogger()
+        build_logger(project_name="TestFilter", console_output=True)
+
+        filter_types = [type(f) for h in root_logger.handlers for f in h.filters]
+        assert _ShortPathFilter in filter_types, "Handlers must have _ShortPathFilter attached"
+
+    def test_calling_build_logger_twice_does_not_stack_filters(self) -> None:
+        build_logger(project_name="TestFilter", console_output=True)
+        build_logger(project_name="TestFilter", console_output=True)
+
+        root_logger = logging.getLogger()
+        for handler in root_logger.handlers:
+            short_path_filters = [f for f in handler.filters if isinstance(f, _ShortPathFilter)]
+            assert (
+                len(short_path_filters) == 1
+            ), f"Expected exactly 1 _ShortPathFilter per handler, found {len(short_path_filters)}"
+
+    def test_shortpath_set_on_logged_records(self, temp_log_file: str) -> None:  # pylint: disable=W0621
+        with patch.dict(os.environ, {"PROJECT_NAME": "custom-python-logger"}):
+            logger = build_logger(
+                project_name="ShortPathTest",
+                log_file=True,
+                log_file_path=temp_log_file,
+                console_output=False,
+            )
+            logger.info("shortpath test message")
+
+        with open(temp_log_file) as f:
+            content = f.read()
+
+        assert "shortpath test message" in content, "Log message not found in file"
+        assert "custom-python-logger/" in content, f"Expected project-relative path in log output, got:\n{content}"