Don't clean up the logger if it's provided#85
Merged
crimsonknave merged 3 commits intomainfrom Nov 7, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a memory management issue where loggers were being prematurely removed from the logger dictionary when a decorated function received an annotated logger from another function. The fix ensures that loggers are only cleaned up when they were created by the decorator itself, not when they were provided from an external source.
Key Changes:
- Added conditional cleanup logic to prevent premature logger removal when
provided=True - Added test coverage to verify correct logger lifecycle management when passing loggers between decorated functions
- Bumped version from 1.3.0 to 1.3.1
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| test/test_memory.py | Adds new test verifying logger persistence when passed between decorated functions |
| annotated_logger/init.py | Implements conditional logger cleanup based on whether logger was provided externally |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Coverage reportClick to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
sophiagavrila
approved these changes
Oct 23, 2025
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
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.
In #83 I added logic to clean up the logger when the decorated function was done. I neglected to account for when the decorated function was provided another function's annotated logger. The logger would have been deleted from the logger dict early, but would have still existed and functioned. This shouldn't cause issues except in rare cases, but it's still good to behave as expected.