Miss Islington (bot) 3bd2818664 [3.13] gh-67022: Document bytes/str inconsistency in email.header.decode_header() and suggest email.headerregistry.HeaderRegistry as a sane alternative (GH-92900) (#135549) ... gh-67022: Document bytes/str inconsistency in email.header.decode_header() and suggest email.headerregistry.HeaderRegistry as a sane alternative (GH-92900) * gh-67022: Document bytes/str inconsistency in email.header.decode_header() This function's possible return types have been surprising and error-prone for the entirety of its Python 3.x history. It can return either: 1. `typing.List[typing.Tuple[bytes, typing.Optional[str]]]` of length >1 2. or `typing.List[typing.Tuple[str, None]]`, of length exactly 1 This means that any user of this function must be prepared to accept either `bytes` or `str` for the first member of the 2-tuples it returns, which is a very surprising behavior in Python 3.x, particularly given that the second member of the tuple is supposed to represent the charset/encoding of the first member. This patch documents the behavior of this function, and adds test cases to demonstrate it. As discussed in bpo-22833, this cannot be changed in a backwards-compatible way, and some users of this function depend precisely on the existing behavior. Add warnings about obsolescence of 'email.header.decode_header' and 'email.header.make_header' functions. Recommend use of `email.headerregistry.HeaderRegistry` instead, as suggested in https://github.com/python/cpython/pull/92900#discussion_r1112472177 (cherry picked from commit 60181f4ed0) Co-authored-by: Dan Lenski <dlenski@gmail.com>		2025-06-15 16:02:43 -04:00
..
mime
__init__.py
_encoded_words.py
_header_value_parser.py	[3.13] gh-134155: fix AttributeError in email._header_value_parser.get_address (GH-134194) (#135192)	2025-06-06 14:11:15 -04:00
_parseaddr.py
_policybase.py	[3.13] gh-124452: Fix header mismatches when folding/unfolding with email message (GH-125919) (#126917)	2024-11-17 15:06:18 -05:00
architecture.rst
base64mime.py
charset.py
contentmanager.py
encoders.py
errors.py	[3.13] gh-121650: Encode newlines in headers, and verify headers are sound (GH-122233) (#122484)	2024-08-06 19:06:41 +02:00
feedparser.py
generator.py	[3.13] gh-121650: Encode newlines in headers, and verify headers are sound (GH-122233) (#122484)	2024-08-06 19:06:41 +02:00
header.py	[3.13] gh-67022: Document bytes/str inconsistency in email.header.decode_header() and suggest email.headerregistry.HeaderRegistry as a sane alternative (GH-92900) (#135549)	2025-06-15 16:02:43 -04:00
headerregistry.py
iterators.py
message.py	[3.13] gh-98188: Fix EmailMessage.get_payload to decode data when CTE value has extra text (GH-127547) (#128528)	2025-01-07 12:43:04 -05:00
parser.py
policy.py	[3.13] gh-124452: Fix header mismatches when folding/unfolding with email message (GH-125919) (#126917)	2024-11-17 15:06:18 -05:00
quoprimime.py
utils.py	[3.13] gh-134151 Fix TypeError in email.utils.decode_params when sorting RFC 2231 continuations (GH-134687) (#135248)	2025-06-08 07:38:00 +00:00