8000 gh-135307: Fix email error when policy max_line_length is set to 0 or None by zangjiucheng · Pull Request #135367 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-135307: Fix email error when policy max_line_length is set to 0 or None #135367

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

gh-135307: Fix email error when policy max_line_length is set to 0 or None #135367

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a210d49
Merge pull request #169 from python/main
zangjiucheng Jun 8, 2025
e9de710
enhance email content handling: allow infinite line length in encoding
zangjiucheng Jun 10, 2025
0a5f379
Fix lint
zangjiucheng Jun 10, 2025
d0dc3c0
fix: correct formatting in email test cases and NEWS entry
zangjiucheng Jun 10, 2025
77ea798
Update NEWS entry, test case enhance, lint code
zangjiucheng Jun 19, 2025
52e590c
resort import; restructure testcase
zangjiucheng Jun 19, 2025
603ff74
tiny enhance varaible
zangjiucheng Jun 19, 2025
38e6381
Tiny update for test case for better readability
zangjiucheng Jun 21, 2025
fa173ac
test: update test assertion for line wrapping in email messages
zangjiucheng Jul 12, 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
enhance email content handling: allow infinite line length in encoding
  • Loading branch information
@zangjiucheng
zangjiucheng committed Jun 10, 2025
commit e9de7103b9c20ea9b024b028d2231516ff2901f4
11 changes: 7 additions & 4 deletions Lib/email/contentmanager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import sys
import binascii
import email.charset
import email.message
Expand Down Expand Up @@ -142,13 +143,15 @@ def _encode_base64(data, max_line_length):


def _encode_text(string, charset, cte, policy):
# max_line_length 0/None means no limit, ie: infinitely long.
maxlen = policy.max_line_length or sys.maxsize
lines = string.encode(charset).splitlines()
linesep = policy.linesep.encode('ascii')
def embedded_body(lines): return linesep.join(lines) + linesep
def normal_body(lines): return b'\n'.join(lines) + b'\n'
if cte is None:
# Use heuristics to decide on the "best" encoding.
if max((len(x) for x in lines), default=0) <= policy.max_line_length:
if max((len(x) for x in lines), default=0) <= maxlen:
Copy link
Member

Choose a reason for hiding this comment

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

We can use: max(map(len, lines), default=0), though I'm not sure which is the fastest and which is the most "readable".

@bitdancer What is the style you'd recommend in general in the email package? would you rather for readability, succintness, or performance?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just my comment: we're not required to take the fastest route here, since we may not have a heavy load on the email module. Still wish to hear more comments before we resolve this :)

try:
return '7bit', normal_body(lines).decode('ascii')
except UnicodeDecodeError:
Expand All @@ -157,7 +160,7 @@ def normal_body(lines): return b'\n'.join(lines) + b'\n'
return '8bit', normal_body(lines).decode('ascii', 'surrogateescape')
sniff = embedded_body(lines[:10])
sniff_qp = quoprimime.body_encode(sniff.decode('latin-1'),
policy.max_line_length)
maxlen)
sniff_base64 = binascii.b2a_base64(sniff)
# This is a little unfair to qp; it includes lineseps, base64 doesn't.
if len(sniff_qp) > len(sniff_base64):
Expand All @@ -172,9 +175,9 @@ def normal_body(lines): return b'\n'.join(lines) + b'\n'
data = normal_body(lines).decode('ascii', 'surrogateescape')
elif cte == 'quoted-printable':
data = quoprimime.body_encode(normal_body(lines).decode('latin-1'),
policy.max_line_length)
maxlen)
elif cte == 'base64':
data = _encode_base64(embedded_body(lines), policy.max_line_length)
data = _encode_base64(embedded_body(lines), maxlen)
else:
raise ValueError("Unknown content transfer encoding {}".format(cte))
return cte, data
Expand Down
28 changes: 28 additions & 0 deletions Lib/test/test_email/test_message.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1004,6 +1004,34 @@ def test_folding_with_long_nospace_http_policy_1(self):
parsed_msg = message_from_bytes(m.as_bytes(), policy=policy.default)
self.assertEqual( 10000 parsed_msg['Message-ID'], m['Message-ID'])

def test_no_wrapping_with_zero_max_line_length(self):
pol = policy.default.clone(max_line_length=0)
subj = "S" * 100
msg = EmailMessage(policy=pol)
msg["From"] = "a@ex.com"
msg["To"] = "b@ex.com"
msg["Subject"] = subj

raw = msg.as_bytes()
self.assertNotIn(b"\r\n ", raw, "Found fold indicator; wrapping not disabled")

parsed = message_from_bytes(raw, policy=policy.default)
self.assertEqual(parsed["Subject"], subj)

def test_no_wrapping_with_none_max_line_length(self):
pol = policy.default.clone(max_line_length=None)
subj = "S" * 100
body = "B" * 100
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we should use some bigger number? Because word "unlimited" is present. Something like 10**7, for example.

Copy link
Contributor Author
@zangjiucheng zangjiucheng Jun 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I don't think it's necessary, here we just want to test if it will wrap the context to the default 78 characters. 0 / None is set it to no wrap mode. This is a similar fix logic as _refold_parse_tree so I mentioned 'unlimited' as there, but it actually takes sys.maxsize. Thanks for comment.

msg = EmailMessage(policy=pol)
msg["From"] = "a@ex.com"
msg["To"] = "b@ex.com"
msg["Subject"] = subj
msg.set_content(body)

parsed = message_from_bytes(msg.as_bytes(), policy=policy.default)
self.assertEqual(parsed["Subject"], subj)
self.assertEqual(parsed.get_body().get_content().rstrip('\n'), body)

def test_invalid_header_names(self):
invalid_headers = [
('Invalid Header', 'contains space'),
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2025-06-10-18-02-29.gh-issue-135307.fXGrcK.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
:mod:`email`: Ensure policy accepts unlimited line lengths by
treating 0 or :const:`None` as :data:`sys.maxsize`
Loading
0