Don't assume that LogRecord.args is a tuple
#12752
Merged
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
In the context of pip, and especially when `rich=True`, I bet it *is* true that `LogRecord.args` is always a tuple. However, in general, this is not true. Single argument dicts actually [are treated specially by Python's logging infrastructure](https://github.com/python/cpython/blob/v3.11.9/Lib/logging/__init__.py#L301-L320): >>> def build_record(*args): ... return LogRecord(name="name", level=0, pathname="pathname", lineno=42, msg="msg", args=args, exc_info=False).args ... >>> build_record({"foo": 42}, {"bar": 43}) ({'foo': 42}, {'bar': 43}) # <-- this is a tuple! >>> build_record(42) (42,) # <-- this is a tuple! >>> build_record({"foo": 42}) {'foo': 42} # <-- this is not a tuple! This fixes pypa#12751 While I was in here, I also changed our logging story so we can actually capture the full stacktrace when logging is turned up. That would have been quite useful for me when debugging this issue, and would also be useful for folks debugging keyring backends. Hopefully this is uncontroversial. Happy to split this out into a separate PR if folks prefer.
uranusjr
approved these changes
Jun 6, 2024
|
Thanks @jfly! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 the context of pip, and especially when
rich=True, I bet it is true thatLogRecord.argsis always a tuple.However, in general, this is not true. Single argument dicts actually are treated specially by Python's logging
infrastructure:
This fixes #12751
While I was in here, I also changed our logging story so we can actually capture the full stacktrace when logging is turned up. That would have been quite useful for me when debugging this issue, and would also be useful for folks debugging keyring backends. Hopefully this is uncontroversial. Happy to split this out into a separate PR if folks prefer.