structlog-config 0.6.0__tar.gz → 0.7.0__tar.gz

{structlog_config-0.6.0 → structlog_config-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: structlog-config
-Version: 0.6.0
+Version: 0.7.0
 Summary: A comprehensive structlog configuration with sensible defaults for development and production environments, featuring context management, exception formatting, and path prettification.
 Keywords: logging,structlog,json-logging,structured-logging
 Author: Michael Bianco
@@ -120,6 +120,64 @@ For example, if you wanted to [mimic `OPENAI_LOG` functionality](https://github.
 * `LOG_LEVEL_HTTPX=DEBUG`
 * `LOG_PATH_HTTPX=tmp/openai.log`
 
+## Custom Formatters
+
+This package includes several custom formatters that automatically clean up log output:
+
+### Path Prettifier
+
+Automatically formats `pathlib.Path` and `PosixPath` objects to show relative paths when possible, removing the wrapper class names:
+
+```python
+from pathlib import Path
+log.info("Processing file", file_path=Path.cwd() / "data" / "users.csv")
+# Output: file_path=data/users.csv (instead of PosixPath('/home/user/data/users.csv'))
+```
+
+### Whenever Datetime Formatter
+
+**Note:** Requires `pip install whenever` to be installed.
+
+Formats [whenever](https://github.com/ariebovenberg/whenever) datetime objects without their class wrappers for cleaner output:
+
+```python
+from whenever import ZonedDateTime
+
+log.info("Event scheduled", event_time=ZonedDateTime(2025, 11, 2, 0, 0, 0, tz="UTC"))
+# Output: event_time=2025-11-02T00:00:00+00:00[UTC]
+# Instead of: event_time=ZonedDateTime("2025-11-02T00:00:00+00:00[UTC]")
+```
+
+Supports all whenever datetime types: `ZonedDateTime`, `Instant`, `LocalDateTime`, `PlainDateTime`, etc.
+
+### ActiveModel Object Formatter
+
+**Note:** Requires `pip install activemodel` and `pip install typeid-python` to be installed.
+
+Automatically converts [ActiveModel](https://github.com/iloveitaly/activemodel) BaseModel instances to their ID representation and TypeID objects to strings:
+
+```python
+from activemodel import BaseModel
+
+user = User(id="user_123", name="Alice")
+log.info("User action", user=user)
+# Output: user_id=user_123 (instead of full object representation)
+```
+
+### FastAPI Context
+
+**Note:** Requires `pip install starlette-context` to be installed.
+
+Automatically includes all context data from [starlette-context](https://github.com/tomwojcik/starlette-context) in your logs, useful for request tracing:
+
+```python
+# Context data (request_id, correlation_id, etc.) automatically included in all logs
+log.info("Processing request")
+# Output includes: request_id=abc-123 correlation_id=xyz-789 ...
+```
+
+All formatters are optional and automatically enabled when their respective dependencies are installed. They work seamlessly in both development (console) and production (JSON) logging modes.
+
 ## FastAPI Access Logger
 
 **Note:** Requires `pip install structlog-config[fastapi]` for FastAPI dependencies.
@@ -193,6 +251,16 @@ FAILED tests/test_user.py::test_user_login
 
 For passing tests, no log output is shown, keeping your test output clean and focused.
 
+## Beautiful Traceback Support
+
+Optional support for [beautiful-traceback](https://github.com/iloveitaly/beautiful-traceback) provides enhanced exception formatting with improved readability, smart coloring, path aliasing (e.g., `<pwd>`, `<site>`), and better alignment. Automatically activates when installed:
+
+```bash
+uv add beautiful-traceback --group dev
+```
+
+No configuration needed - just install and `configure_logger()` will use it automatically.
+
 ## iPython
 
 Often it's helpful to update logging level within an iPython session. You can do this and make sure all loggers pick up on it.

{structlog_config-0.6.0 → structlog_config-0.7.0}/README.md

@@ -103,6 +103,64 @@ For example, if you wanted to [mimic `OPENAI_LOG` functionality](https://github.
 * `LOG_LEVEL_HTTPX=DEBUG`
 * `LOG_PATH_HTTPX=tmp/openai.log`
 
+## Custom Formatters
+
+This package includes several custom formatters that automatically clean up log output:
+
+### Path Prettifier
+
+Automatically formats `pathlib.Path` and `PosixPath` objects to show relative paths when possible, removing the wrapper class names:
+
+```python
+from pathlib import Path
+log.info("Processing file", file_path=Path.cwd() / "data" / "users.csv")
+# Output: file_path=data/users.csv (instead of PosixPath('/home/user/data/users.csv'))
+```
+
+### Whenever Datetime Formatter
+
+**Note:** Requires `pip install whenever` to be installed.
+
+Formats [whenever](https://github.com/ariebovenberg/whenever) datetime objects without their class wrappers for cleaner output:
+
+```python
+from whenever import ZonedDateTime
+
+log.info("Event scheduled", event_time=ZonedDateTime(2025, 11, 2, 0, 0, 0, tz="UTC"))
+# Output: event_time=2025-11-02T00:00:00+00:00[UTC]
+# Instead of: event_time=ZonedDateTime("2025-11-02T00:00:00+00:00[UTC]")
+```
+
+Supports all whenever datetime types: `ZonedDateTime`, `Instant`, `LocalDateTime`, `PlainDateTime`, etc.
+
+### ActiveModel Object Formatter
+
+**Note:** Requires `pip install activemodel` and `pip install typeid-python` to be installed.
+
+Automatically converts [ActiveModel](https://github.com/iloveitaly/activemodel) BaseModel instances to their ID representation and TypeID objects to strings:
+
+```python
+from activemodel import BaseModel
+
+user = User(id="user_123", name="Alice")
+log.info("User action", user=user)
+# Output: user_id=user_123 (instead of full object representation)
+```
+
+### FastAPI Context
+
+**Note:** Requires `pip install starlette-context` to be installed.
+
+Automatically includes all context data from [starlette-context](https://github.com/tomwojcik/starlette-context) in your logs, useful for request tracing:
+
+```python
+# Context data (request_id, correlation_id, etc.) automatically included in all logs
+log.info("Processing request")
+# Output includes: request_id=abc-123 correlation_id=xyz-789 ...
+```
+
+All formatters are optional and automatically enabled when their respective dependencies are installed. They work seamlessly in both development (console) and production (JSON) logging modes.
+
 ## FastAPI Access Logger
 
 **Note:** Requires `pip install structlog-config[fastapi]` for FastAPI dependencies.
@@ -176,6 +234,16 @@ FAILED tests/test_user.py::test_user_login
 
 For passing tests, no log output is shown, keeping your test output clean and focused.
 
+## Beautiful Traceback Support
+
+Optional support for [beautiful-traceback](https://github.com/iloveitaly/beautiful-traceback) provides enhanced exception formatting with improved readability, smart coloring, path aliasing (e.g., `<pwd>`, `<site>`), and better alignment. Automatically activates when installed:
+
+```bash
+uv add beautiful-traceback --group dev
+```
+
+No configuration needed - just install and `configure_logger()` will use it automatically.
+
 ## iPython
 
 Often it's helpful to update logging level within an iPython session. You can do this and make sure all loggers pick up on it.

{structlog_config-0.6.0 → structlog_config-0.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "structlog-config"
-version = "0.6.0"
+version = "0.7.0"
 description = "A comprehensive structlog configuration with sensible defaults for development and production environments, featuring context management, exception formatting, and path prettification."
 keywords = ["logging", "structlog", "json-logging", "structured-logging"]
 readme = "README.md"
@@ -27,8 +27,10 @@ module-root = ""
 
 [dependency-groups]
 dev = [
+    "beautiful-traceback>=0.1.0",
     "fastapi>=0.115.12",
     "httpx>=0.28.1",
     "pytest>=8.3.3",
     "fastapi_ipware>=0.1.0",
+    "whenever>=0.9.3",
 ]

{structlog_config-0.6.0 → structlog_config-0.7.0}/structlog_config/__init__.py

@@ -11,9 +11,10 @@ from structlog.typing import FilteringBoundLogger
 
 from structlog_config.formatters import (
     PathPrettifier,
+    WheneverFormatter,
     add_fastapi_context,
+    beautiful_traceback_exception_formatter,
     logger_name,
-    pretty_traceback_exception_formatter,
     simplify_activemodel_objects,
 )
 
@@ -64,8 +65,8 @@ def log_processors_for_mode(json_logger: bool) -> list[structlog.types.Processor
     return [
         structlog.dev.ConsoleRenderer(
             colors=not NO_COLOR,
-            exception_formatter=pretty_traceback_exception_formatter
-            if packages.pretty_traceback
+            exception_formatter=beautiful_traceback_exception_formatter
+            if packages.beautiful_traceback
             else structlog.dev.default_exception_formatter,
         )
     ]
@@ -85,6 +86,7 @@ def get_default_processors(json_logger) -> list[structlog.types.Processor]:
         if packages.activemodel and packages.typeid
         else None,
         PathPrettifier(),
+        WheneverFormatter() if packages.whenever else None,
         structlog.processors.TimeStamper(fmt="iso", utc=True),
         # add `stack_info=True` to a log and get a `stack` attached to the log
         structlog.processors.StackInfoRenderer(),

{structlog_config-0.6.0 → structlog_config-0.7.0}/structlog_config/formatters.py

@@ -64,17 +64,17 @@ def logger_name(logger: Any, method_name: Any, event_dict: EventDict) -> EventDi
     return event_dict
 
 
-def pretty_traceback_exception_formatter(sio: TextIO, exc_info: ExcInfo) -> None:
+def beautiful_traceback_exception_formatter(sio: TextIO, exc_info: ExcInfo) -> None:
     """
     By default, rich and then better-exceptions is used to render exceptions when a ConsoleRenderer is used.
 
-    I prefer pretty-traceback, so I've added a custom processor to use it.
+    I prefer beautiful-traceback, so I've added a custom processor to use it.
 
     https://github.com/hynek/structlog/blob/66e22d261bf493ad2084009ec97c51832fdbb0b9/src/structlog/dev.py#L412
     """
 
     # only available in dev
-    from pretty_traceback.formatting import exc_to_traceback_str
+    from beautiful_traceback.formatting import exc_to_traceback_str
 
     _, exc_value, traceback = exc_info
     # TODO support local_stack_only env var support
@@ -150,6 +150,26 @@ class RenameField:
         return event_dict
 
 
+class WheneverFormatter:
+    """A processor for formatting whenever datetime objects.
+
+    Changes all whenever datetime objects (ZonedDateTime, Instant, PlainDateTime, etc.)
+    from their repr() format (e.g., ZonedDateTime("2025-11-02 00:00:00+00:00[UTC]"))
+    to their string format (e.g., 2025-11-02 00:00:00+00:00[UTC]).
+
+    This provides cleaner log output without the class wrapper.
+    """
+
+    def __call__(self, _, __, event_dict):
+        for key, value in event_dict.items():
+            # Check if the value has the _pywhenever module attribute
+            # This is a reliable way to detect whenever types without importing them
+            if hasattr(value, "__module__") and value.__module__.startswith("whenever"):
+                event_dict[key] = str(value)
+
+        return event_dict
+
+
 def add_fastapi_context(
     logger: logging.Logger,
     method_name: str,

{structlog_config-0.6.0 → structlog_config-0.7.0}/structlog_config/packages.py

@@ -23,11 +23,16 @@ except ImportError:
     typeid = None
 
 try:
-    import pretty_traceback
+    import beautiful_traceback
 except ImportError:
-    pretty_traceback = None
+    beautiful_traceback = None
 
 try:
     import starlette_context
 except ImportError:
     starlette_context = None
+
+try:
+    import whenever
+except ImportError:
+    whenever = None