Dan Lenski 60181f4ed0 gh-67022: Document bytes/str inconsistency in email.header.decode_header() and suggest email.headerregistry.HeaderRegistry as a sane alternative (#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		2025-06-15 15:29:38 -04:00
..
mime	gh-126133: Only use start year in PSF copyright, remove end years (#126236)	2024-11-12 15:59:19 +02:00
__init__.py	gh-126133: Only use start year in PSF copyright, remove end years (#126236)	2024-11-12 15:59:19 +02:00
_encoded_words.py	bpo-43323: Fix UnicodeEncodeError in the email module (GH-32137)	2022-04-30 13:17:23 +03:00
_header_value_parser.py	gh-134155: fix AttributeError in email._header_value_parser.get_address (#134194)	2025-06-05 13:28:11 -04:00
_parseaddr.py	gh-126133: Only use start year in PSF copyright, remove end years (#126236)	2024-11-12 15:59:19 +02:00
_policybase.py	gh-127794: Validate email header names according to RFC 5322 (#127820)	2025-03-30 12:29:29 +00:00
architecture.rst	Fix typos in multiple .rst files (#1668)	2017-05-19 23:37:57 +03:00
base64mime.py	gh-126133: Only use start year in PSF copyright, remove end years (#126236)	2024-11-12 15:59:19 +02:00
charset.py	gh-126133: Only use start year in PSF copyright, remove end years (#126236)	2024-11-12 15:59:19 +02:00
contentmanager.py	bpo-46565: del loop vars that are leaking into module namespaces (GH-30993)	2022-02-03 11:20:08 +02:00
encoders.py	gh-126133: Only use start year in PSF copyright, remove end years (#126236)	2024-11-12 15:59:19 +02:00
errors.py	gh-126133: Only use start year in PSF copyright, remove end years (#126236)	2024-11-12 15:59:19 +02:00
feedparser.py	gh-133306: Use \z instead of \Z in regular expressions in the stdlib (GH-133337)	2025-05-03 17:58:49 +03:00
generator.py	gh-126133: Only use start year in PSF copyright, remove end years (#126236)	2024-11-12 15:59:19 +02:00
header.py	gh-67022: Document bytes/str inconsistency in email.header.decode_header() and suggest email.headerregistry.HeaderRegistry as a sane alternative (#92900)	2025-06-15 15:29:38 -04:00
headerregistry.py	bpo-26579: Add object.__getstate__(). (GH-2821)	2022-04-06 20:00:14 +03:00
iterators.py	gh-126133: Only use start year in PSF copyright, remove end years (#126236)	2024-11-12 15:59:19 +02:00
message.py	Docs: fix docstring of email.message.Message.add_header (#134355)	2025-06-10 12:35:37 +02:00
parser.py	gh-126133: Only use start year in PSF copyright, remove end years (#126236)	2024-11-12 15:59:19 +02:00
policy.py	gh-127794: Validate email header names according to RFC 5322 (#127820)	2025-03-30 12:29:29 +00:00
quoprimime.py	gh-126133: Only use start year in PSF copyright, remove end years (#126236)	2024-11-12 15:59:19 +02:00
utils.py	gh-134151 Fix TypeError in email.utils.decode_params when sorting RFC 2231 continuations (#134687)	2025-06-08 09:13:21 +02:00