docs: clarify append_context_keys behavior with overlapping keys #7846
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
Fixes aws-powertools#7690 Clarifies that append_context_keys() removes all added keys on exit, including keys that already existed with the same name. This addresses user confusion about the 'temporarily' behavior when keys overlap. Changes: - Updated docstrings in formatter.py and logger.py with clear warning - Added detailed documentation in logger.md with collision example - Explains that original values are lost when keys overlap - Recommends using append_keys() for persistent keys to avoid collisions This is a documentation-only fix that clarifies current behavior without changing functionality.
pull-request-size
bot
added
the
size/S
boring-cyborg
bot
added
documentation
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Issue number: closes #7690
Summary
This PR clarifies the behavior of
append_context_keys()when keys overlap with existing keys, addressing user confusion reported in #7690. This is a documentation-only fix that explains the current implementation without changing functionality.Changes
Updated docstrings in
formatter.pyandlogger.py:append_keys()for persistent keysEnhanced documentation in
docs/core/logger.md:order_id="ORD-123"is lost after usingappend_context_keys(order_id="ORD-CHILD")User experience
Before:
After:
append_keys()for persistent context, avoid overlapping key names withappend_context_keys()By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.