Skip to content

docs: clarify SchemaLogger compatibility guarantees #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
disafronov merged 2 commits into from
Oct 25, 2026
Merged

docs: clarify SchemaLogger compatibility guarantees #87

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b6986a
docs: clarify SchemaLogger compatibility contract
disafronov Oct 25, 2026
a83b56a
docs: fix class docstring indentation
disafronov Oct 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions src/logging_objects_with_schema/schema_logger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
This class extends the standard ``logging.Logger`` to validate and filter
user-provided ``extra`` fields according to a compiled JSON schema. When
validation problems are detected, they are logged as ERROR messages *after*
the log record has been emitted, ensuring 100% compatibility with standard
logger behavior.
the main log record has been emitted. The standard logging call API is
preserved, but ``extra`` handling intentionally differs from ``logging.Logger``.
"""

import json
Expand Down Expand Up @@ -45,7 +45,8 @@ class SchemaLogger(logging.Logger):

This class extends :class:`logging.Logger` to add validation for
``extra`` fields according to a compiled JSON schema. It is designed
to be used as a drop-in replacement via :func:`logging.setLoggerClass`.
to be installed via :func:`logging.setLoggerClass`. Logging calls retain
the standard API, while ``extra`` is schema-validated and projected.

The schema is loaded from ``logging_objects_with_schema.json`` found by
searching upward from the current working directory to the filesystem root
Expand Down Expand Up @@ -118,8 +119,8 @@ def _log(
This method validates and filters the ``extra`` parameter according
to the compiled schema before delegating to the parent class. If
validation problems are detected, they are logged as ERROR messages
after the main log record has been emitted, ensuring compatibility
with standard logger behavior (no exceptions are raised).
after the main log record has been emitted. Invalid runtime ``extra``
values are reported separately instead of raising validation errors.

Args:
level: Logging level.
Expand Down
Loading