Repository navigation
Include header name in encoding error message - #3767
Open
worksbyfriday wants to merge 1 commit into
Open
worksbyfriday wants to merge 1 commit into
worksbyfriday wants to merge 1 commit into
Conversation
When a header value contains non-ASCII characters that can't be encoded, the error message now includes the header name, making it easier to identify which header is causing the issue. Fixes encode#3400 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
| return key if isinstance(key, bytes) else key.encode(encoding or "ascii") | ||
|
|
||
|
|
||
| def _normalize_header_value(value: str | bytes, encoding: str | None = None) -> bytes: |
There was a problem hiding this comment.
The new error context is useful, but it appears to cover only header initialization.
Headers.__setitem__() still encodes values directly:
set_value = value.encode(self._encoding or "utf-8")For example:
headers = httpx.Headers(encoding="ascii")
headers["X-Test"] = "café"This still raises a UnicodeEncodeError without identifying X-Test, whereas constructing the same header through Headers({"X-Test": "café"}, encoding="ascii") now includes the name.
Could we route __setitem__() through _normalize_header_value(..., name=key) as well, or otherwise include the header name when assignment fails?
A regression test covering both initialization and assignment with an explicit ASCII encoding would ensure consistent diagnostics.
This branch has not been deployed
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.
Summary
UnicodeEncodeErrornow includes the header name'ascii' codec can't encode characters in position 0-27: ordinal not in range(128)'ascii' codec can't encode characters in position 0-27: ordinal not in range(128) (header: 'auth')Fixes #3400
Test plan
test_header_encoding_error_includes_nameverifying error message contains header name