Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-136702: Deprecate passing non-ascii *encoding* (str) to encodings.normalize_encoding #140030

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
malemburg merged 11 commits into from
Nov 9, 2025
Merged

gh-136702: Deprecate passing non-ascii *encoding* (str) to encodings.normalize_encoding #140030

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
c8fc658
deprecate non-ascii
StanFromIreland Oct 13, 2025
5b50daa
Relocate import
StanFromIreland Oct 13, 2025
95f2e65
sanitize charset names in email
StanFromIreland Oct 13, 2025
fad52cd
Use table, replace with 'ascii'
StanFromIreland Oct 16, 2025
3ac0804
Merge branch 'main' into encodings/non-ascii
StanFromIreland Oct 31, 2025
9d6f06e
Review
StanFromIreland Nov 1, 2025
16697dc
Fix second warning
StanFromIreland Nov 1, 2025
e4036f8
Convert to asserts
StanFromIreland Nov 1, 2025
b8fc5f4
Fix for platforms with ordered tests
StanFromIreland Nov 1, 2025
7592af8
!fixup
StanFromIreland Nov 1, 2025
8c59899
Fix CI on Android and iOS
StanFromIreland Nov 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Review
  • Loading branch information
@StanFromIreland
StanFromIreland committed Nov 1, 2025
commit 9d6f06e00ebe87ed5c163e37ce12287c80a8071b
3 changes: 1 addition & 2 deletions Lib/email/_header_value_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -796,14 +796,13 @@ def params(self):
value = urllib.parse.unquote(value, encoding='latin-1')
else:
try:
charset = utils._sanitize_charset_name(charset, 'ascii')
value = value.decode(charset, 'surrogateescape')
except (LookupError, UnicodeEncodeError):
# XXX: there should really be a custom defect for
# unknown character set to make it easy to find,
# because otherwise unknown charset is a silent
# failure.
value = value.decode('ascii', 'surrogateescape')
value = value.decode('us-ascii', 'surrogateescape')
if utils._has_surrogates(value):
param.defects.append(errors.UndecodableBytesDefect())
value_parts.append(value)
Expand Down
11 changes: 1 addition & 10 deletions Lib/email/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,16 +446,8 @@ def decode_params(params):
new_params.append((name, '"%s"' % value))
return new_params

_SANITIZE_TABLE = str.maketrans({i: None for i in range(128, 65536)})

def _sanitize_charset_name(charset, fallback_charset):
if not charset:
return charset
sanitized = charset.translate(_SANITIZE_TABLE)
return sanitized if sanitized else fallback_charset

def collapse_rfc2231_value(value, errors='replace',
fallback_charset='ascii'):
fallback_charset='us-ascii'):
if not isinstance(value, tuple) or len(value) != 3:
return unquote(value)
# While value comes to us as a unicode string, we need it to be a bytes
Expand All @@ -466,7 +458,6 @@ def collapse_rfc2231_value(value, errors='replace',
# Issue 17369: if charset/lang is None, decode_rfc2231 couldn't parse
# the value, so use the fallback_charset.
charset = fallback_charset
charset = _sanitize_charset_name(charset, fallback_charset)
rawbytes = bytes(text, 'raw-unicode-escape')
try:
return str(rawbytes, charset, errors)
Expand Down
5 changes: 4 additions & 1 deletion Lib/test/test_email/test_email.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5717,7 +5717,10 @@ def test_rfc2231_bad_character_in_encoding(self):

"""
msg = email.message_from_string(m)
self.assertEqual(msg.get_filename(), 'myfile.txt')
import warnings
with warnings.catch_warnings():
warnings.simplefilter("ignore", DeprecationWarning)
self.assertEqual(msg.get_filename(), 'myfile.txt')
Copy link
Copy Markdown
Member Author

@StanFromIreland StanFromIreland Nov 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bitdancer It was indeed tested.

Copy link
Copy Markdown
Member

@bitdancer bitdancer Nov 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I missed that. I guess maybe warnings weren't enabled the way I ran the tests, though I thought I was doing so...

Copy link
Copy Markdown
Member Author

@StanFromIreland StanFromIreland Nov 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you want to do, keep it like so or revert to my backwards-compatible approach?

Copy link
Copy Markdown
Member

@bitdancer bitdancer Nov 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe I've confirmed that the tests will still pass after lookup starts raising a ValueError, which is what I was hoping would happen. I wonder if we should actually assert the deprecation warning here, though, so that we are reminded to remove the check when the deprecation turns into reality. I'm fine with whatever is standard practice for such cases, though.

Copy link
Copy Markdown
Member Author

@StanFromIreland StanFromIreland Nov 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Converted to asserts.


def test_rfc2231_single_tick_in_filename_extended(self):
eq = self.assertEqual
Expand Down
Loading