Draft: Add logging system #125
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
During fixing of the liniting errors it was found that Ruff and MyPy collide for the decorators.py file. Ruff remove the call of settattr and assigns the value directly to attribute, while MyPy prefers the use of settattr. Therefore, the related rule of Ruff is deactivated for the file.
- Add synchronous and asynchronous logging APIs with identical interfaces - Implement JSON and human-readable formatters with UTC timestamps - Support structured data logging via keyword arguments - Add protocol-based dependency injection for issue tracking and i18n - Implement automatic field extraction from Issue and IssueCollector objects - Add file handlers with automatic directory creation and rotation - Support per-message translation control across all formatters - Add validation summary logging with issue collector integration
…and main.py Signed-off-by: hueseyinhguerbuez <[email protected]>
- Add synchronous and asynchronous logging APIs with identical interfaces - Implement JSON and human-readable formatters with UTC timestamps - Support structured data logging via keyword arguments - Add protocol-based dependency injection for issue tracking and i18n - Implement automatic field extraction from Issue and IssueCollector objects - Add file handlers with automatic directory creation and rotation - Support per-message translation control across all formatters - Add validation summary logging with issue collector integration
# Conflicts: # popupsim/backend/src/core/logging/formatters.py # popupsim/backend/src/core/logging/logger.py # popupsim/backend/src/main.py # popupsim/backend/tests/unit/core/logging/test_async_logger.py # popupsim/backend/tests/unit/core/logging/test_handlers.py # popupsim/backend/tests/unit/core/logging/test_logger.py
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This pull request adds a logging system for synchronous and asynchronous logging. It is designed to be easily enhanced by a translator (i18n) and an issue tracker by using a protocols pattern. A structured logger along with different file formatters and log rotation are readily available. Refer to the provided README.md for an overview of features and how to use it.
Formatting changes: logging & Internationalizierung
Updated all logger calls to structured format with translate=True; all ConfigurationError messages wrapped with _() using named parameters; added exc_info=True to all error logs; renamed loop variables from _ to _idx to avoid shadowing i18n function
Added logging to validate() method; translated all ValidationIssue messages and print_summary messages with _(); added exc_info=True to error logs
Related Issues/Tickets
#84
Type of Change
How Has This Been Tested?
Unit tests have to be added to ensure a coverage of 100% taking also edge cases into account.
Checklist
uv run ruff format . && uv run ruff check .)uv run pytest)Additional Notes
The logger can make use of the i18n system provided in #119. Currently the validation of the configuration context has an own implementaiton of error handling and validation stacking. This will be tackled in another PR