custom-python-logger 3.0.1__py3-none-any.whl → 4.0.0__py3-none-any.whl

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/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/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_SHORTPATH, CustomLoggerLevel
 
 CUSTOM_LOGGER = "custom_logger"
 
@@ -48,6 +48,22 @@ 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 CustomLoggerAdapter(logging.LoggerAdapter):
     def exception(self, msg: str, *args: Any, **kwargs: Any) -> None:
         logging.addLevelName(CustomLoggerLevel.EXCEPTION.value, "EXCEPTION")
@@ -118,7 +134,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_SHORTPATH,
     log_level: int = logging.DEBUG,
     log_file: bool = False,
     log_file_path: str | None = None,
@@ -156,6 +172,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.1.dist-info → custom_python_logger-4.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: custom-python-logger
-Version: 3.0.1
+Version: 4.0.0
 Summary: A custom logger with color support and additional features.
 Author: Avi Zaguri
 License: MIT
@@ -17,13 +17,7 @@ Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: colorlog>=6.10.1
-Requires-Dist: pathlib>=1.0.1
-Requires-Dist: pre-commit>=4.5.0
-Requires-Dist: pytest>=9.0.1
-Requires-Dist: python-dotenv>=1.2.1
 Requires-Dist: pyyaml>=6.0.3
-Requires-Dist: setuptools>=80.9.0
-Requires-Dist: wheel>=0.45.1
 Dynamic: license-file
 
 ![PyPI version](https://img.shields.io/pypi/v/custom-python-logger)
@@ -48,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.
 
 ---
@@ -86,6 +81,7 @@ logger.critical("This is a critical message.")
 ```
 
 #### Advanced Usage
+
 - Log to a file:
   ```python
   from custom_python_logger import build_logger
@@ -117,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-4.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+custom_python_logger/__init__.py,sha256=88wm3t65rvclBgmVxHXG0Py5KwZioBK0L7W5I_CiRzw,515
+custom_python_logger/consts.py,sha256=T2YcREZQiuLkujICXDGojSHbwgsDB-fNE8LQMsLWyZ8,698
+custom_python_logger/logger.py,sha256=SsTBUy4YoqyMtrn1c7lETaEx4CNUZcgYuCI5cmr3AIM,6569
+custom_python_logger-4.0.0.dist-info/licenses/LICENSE,sha256=cSikHY6SZFsPZSBizCDAJ0-Bjjzxt-JtX6TVbKxwimo,1067
+custom_python_logger-4.0.0.dist-info/METADATA,sha256=AB0TPnsmobNG9afigiTJ6fRJ-LIAvoE14-yf-hmPcSQ,6249
+custom_python_logger-4.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+custom_python_logger-4.0.0.dist-info/top_level.txt,sha256=lMihLuDQUTn0aSzzzbv9LZZTWTAap0IKpKabUHwOgks,21
+custom_python_logger-4.0.0.dist-info/RECORD,,

custom_python_logger-3.0.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-custom_python_logger/__init__.py,sha256=weJwYyKZx1SGHnpv_jodeNOZOUIAuF7wjJSjp70zWG4,331
-custom_python_logger/consts.py,sha256=ZIZL1Ir9jDHCHu4Vk9-cgja2QWWrIBBNdqOLCzPrFSU,445
-custom_python_logger/logger.py,sha256=6HYY4PohPXjIFKJXH7iaiRi7epOmWQUim41mAlRqx7U,5974
-custom_python_logger-3.0.1.dist-info/licenses/LICENSE,sha256=cSikHY6SZFsPZSBizCDAJ0-Bjjzxt-JtX6TVbKxwimo,1067
-custom_python_logger-3.0.1.dist-info/METADATA,sha256=S0Ihp5c8QMq1DHdzQjVic8c-3nX5BCTsT9sj--M35pQ,4683
-custom_python_logger-3.0.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-custom_python_logger-3.0.1.dist-info/top_level.txt,sha256=lMihLuDQUTn0aSzzzbv9LZZTWTAap0IKpKabUHwOgks,21
-custom_python_logger-3.0.1.dist-info/RECORD,,